Add ignoring some fields during serialization/deserialization

Author: Kirill_Lekhov

django_spinproject/modules/gitlab_ci.py

@@ -1,5 +1,5 @@
 from ._base import BaseModule
-from .gitlab_ci_data import _V1_ENV, _V2_ENV, _V3_ENV, _V4_ENV, _V5_ENV
+from .gitlab_ci_data import _V1_ENV, _V2_ENV, _V3_ENV, _V4_ENV
 from ..project.project_info import ProjectInfo
 
 

django_spinproject/project/memento.py

@@ -41,12 +41,18 @@ def save(self, info: ProjectInfo, overwrite: bool = True) -> None:
 			info: Project info which to be saved.
 			overwrite: Flag for overwriting the project file.
 		"""
-		if not overwrite and self.does_project_file_exist():
-			exit_with_output(f"{self.filename} file already exists", 1)
+		serialization_settings = {}
+
+		if not overwrite:
+			if self.does_project_file_exist():
+				exit_with_output(f"{self.filename} file already exists", 1)
+
+			# If the project file is not overwritten, then a new project may be created.
+			serialization_settings['is_initial'] = True
 
 		try:
 			with open(self.filename, mode='w') as file:
-				json.dump(info.serialize(), file, indent=2)
+				json.dump(info.serialize(**serialization_settings), file, indent=2)
 
 		except PermissionError:
 			exit_with_output("Unable to save project info. Permission denied", 1)

django_spinproject/project/project_info.py

@@ -70,6 +70,23 @@ def deserialize(cls, raw_data: dict) -> 'ProjectInfo':
 
 		return instance
 
+	def serialize(self, **kwargs) -> dict:
+		"""
+		Serializes project info.
+
+		Args:
+			**kwargs: serialization settings.
+
+		Notes:
+			Not all project versions use all settings.
+			Possible kwargs options:
+				`is_initial` - Flag of the initial serialization of project information.
+
+		Returns:
+			Project info in the form of a dictionary.
+		"""
+		return super().serialize()
+
 
 @VERSION_REGISTRY.register
 class ProjectInfoV1(ProjectInfo):
@@ -83,3 +100,35 @@ class ProjectInfoV2(ProjectInfo):
 	ProjectConfig = ProjectConfigV2
 	DockerConfig = DockerConfigV2
 	VERSION = 2
+
+	def __init__(self, project_name: str, main: str = DEFAULT_MAIN):
+		super().__init__(project_name, main)
+		self.serialization_settings = {}
+
+	def serialize(self, **kwargs) -> dict:
+		is_initial = kwargs.get('is_initial', False)
+		serialized_data = super().serialize()
+
+		if is_initial or self.serialization_settings.get(self.DOCKER_LABEL, {}).get('ignore_username', False):
+			self.serialization_settings.setdefault(self.DOCKER_LABEL, {})
+			self.serialization_settings[self.DOCKER_LABEL]['ignore_username'] = True
+			del serialized_data[self.CONFIG_LABEL][self.DOCKER_LABEL]['username']
+
+		del serialized_data['serialization_settings']
+
+		return serialized_data
+
+	@classmethod
+	def deserialize(cls, raw_data: dict) -> 'ProjectInfoV2':
+		if raw_data.get(cls.CONFIG_LABEL, {}).get(cls.DOCKER_LABEL, {}).get('username') is None:
+			docker_username_is_missing = True
+		else:
+			docker_username_is_missing = False
+
+		obj = super().deserialize(raw_data)
+
+		if docker_username_is_missing:
+			obj.serialization_settings.setdefault(cls.DOCKER_LABEL, {})
+			obj.serialization_settings[cls.DOCKER_LABEL]['ignore_username'] = True
+
+		return obj