add pass_validation to each output and update tests

Author: mustafasoylu

src/somesy/cff/writer.py

@@ -18,6 +18,7 @@ def __init__(
         self,
         path: Path,
         create_if_not_exists: bool = True,
+        pass_validation: bool = False,
     ):
         """Citation File Format (CFF) parser.
 
@@ -35,7 +36,10 @@ def __init__(
             "maintainers": ["contact"],
         }
         super().__init__(
-            path, create_if_not_exists=create_if_not_exists, direct_mappings=mappings
+            path,
+            create_if_not_exists=create_if_not_exists,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
         )
 
     def _init_new_file(self):
@@ -53,8 +57,10 @@ def _load(self):
         with open(self.path) as f:
             self._data = self._yaml.load(f)
 
-    def _validate(self):
+    def _validate(self) -> None:
         """Validate the CFF file."""
+        if self.pass_validation:
+            return
         try:
             citation = create_citation(self.path, None)
             citation.validate()

src/somesy/codemeta/writer.py

@@ -20,6 +20,7 @@ def __init__(
         self,
         path: Path,
         merge: Optional[bool] = False,
+        pass_validation: Optional[bool] = False,
     ):
         """Codemeta.json parser.
 
@@ -46,7 +47,12 @@ def __init__(
         if path.is_file() and not self.merge:
             logger.verbose("Deleting existing codemeta.json file.")
             path.unlink()
-        super().__init__(path, create_if_not_exists=True, direct_mappings=mappings)
+        super().__init__(
+            path,
+            create_if_not_exists=True,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
+        )
 
         # if merge is True, add necessary keys to the codemeta.json file
         if self.merge:
@@ -95,6 +101,8 @@ def _load(self) -> None:
 
     def _validate(self) -> None:
         """Validate codemeta.json content using pydantic class."""
+        if self.pass_validation:
+            return
         invalid_fields = validate_codemeta(self._data)
         if invalid_fields and self.merge:
             raise ValueError(

src/somesy/fortran/writer.py

@@ -18,7 +18,11 @@
 class Fortran(ProjectMetadataWriter):
     """Fortran config file handler parsed from fpm.toml."""
 
-    def __init__(self, path: Path):
+    def __init__(
+        self,
+        path: Path,
+        pass_validation: Optional[bool] = False,
+    ):
         """Fortran config file handler parsed from fpm.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
@@ -28,7 +32,12 @@ def __init__(self, path: Path):
             "maintainers": ["maintainer"],
             "documentation": IgnoreKey(),
         }
-        super().__init__(path, create_if_not_exists=False, direct_mappings=mappings)
+        super().__init__(
+            path,
+            create_if_not_exists=False,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
+        )
 
     @property
     def authors(self):
@@ -71,6 +80,8 @@ def _validate(self) -> None:
         In order to preserve toml comments and structure, tomlkit library is used.
         Pydantic class only used for validation.
         """
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {FortranConfig.__name__}: {pretty_repr(config)}"

src/somesy/julia/writer.py

@@ -18,12 +18,20 @@
 class Julia(ProjectMetadataWriter):
     """Julia config file handler parsed from Project.toml."""
 
-    def __init__(self, path: Path):
+    def __init__(
+        self,
+        path: Path,
+        pass_validation: Optional[bool] = False,
+    ):
         """Julia config file handler parsed from Project.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
         """
-        super().__init__(path, create_if_not_exists=False)
+        super().__init__(
+            path,
+            create_if_not_exists=False,
+            pass_validation=pass_validation,
+        )
 
     def _load(self) -> None:
         """Load Project.toml file."""
@@ -36,6 +44,8 @@ def _validate(self) -> None:
         In order to preserve toml comments and structure, tomlkit library is used.
         Pydantic class only used for validation.
         """
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {JuliaConfig.__name__}: {pretty_repr(config)}"

src/somesy/mkdocs/writer.py

@@ -17,7 +17,12 @@
 class MkDocs(ProjectMetadataWriter):
     """Project documentation with Markdown (MkDocs) parser and saver."""
 
-    def __init__(self, path: Path, create_if_not_exists: bool = False):
+    def __init__(
+        self,
+        path: Path,
+        create_if_not_exists: bool = False,
+        pass_validation: Optional[bool] = False,
+    ):
         """Project documentation with Markdown (MkDocs) parser.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
@@ -38,16 +43,21 @@ def __init__(self, path: Path, create_if_not_exists: bool = False):
             "keywords": IgnoreKey(),
         }
         super().__init__(
-            path, create_if_not_exists=create_if_not_exists, direct_mappings=mappings
+            path,
+            create_if_not_exists=create_if_not_exists,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
         )
 
     def _load(self):
         """Load the MkDocs file."""
         with open(self.path) as f:
             self._data = self._yaml.load(f)
 
-    def _validate(self):
+    def _validate(self) -> None:
         """Validate the MkDocs file."""
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {MkDocsConfig.__name__}: {pretty_repr(config)}"

src/somesy/package_json/writer.py

@@ -21,6 +21,7 @@ class PackageJSON(ProjectMetadataWriter):
     def __init__(
         self,
         path: Path,
+        pass_validation: Optional[bool] = False,
     ):
         """package.json parser.
 
@@ -30,7 +31,12 @@ def __init__(
             "authors": ["author"],
             "documentation": IgnoreKey(),
         }
-        super().__init__(path, create_if_not_exists=False, direct_mappings=mappings)
+        super().__init__(
+            path,
+            create_if_not_exists=False,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
+        )
 
     @property
     def authors(self):
@@ -106,6 +112,8 @@ def _load(self) -> None:
 
     def _validate(self) -> None:
         """Validate package.json content using pydantic class."""
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {PackageJsonConfig.__name__}: {pretty_repr(config)}"

src/somesy/pom_xml/writer.py

@@ -24,6 +24,7 @@ def __init__(
         self,
         path: Path,
         create_if_not_exists: bool = True,
+        pass_validation: Optional[bool] = False,
     ):
         """Java Maven pom.xml parser.
 
@@ -40,7 +41,10 @@ def __init__(
             "contributors": ["contributors", "contributor"],
         }
         super().__init__(
-            path, create_if_not_exists=create_if_not_exists, direct_mappings=mappings
+            path,
+            create_if_not_exists=create_if_not_exists,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
         )
 
     def _init_new_file(self):
@@ -54,7 +58,7 @@ def _load(self):
         ET.register_namespace("", POM_URL)  # register POM as default xml namespace
         self._data = XMLProxy.parse(self.path, default_namespace=POM_URL)
 
-    def _validate(self):
+    def _validate(self) -> None:
         """Validate the POM file."""
         logger.info("Cannot validate POM file, skipping validation.")
 

src/somesy/pyproject/writer.py

@@ -21,7 +21,13 @@ class PyprojectCommon(ProjectMetadataWriter):
     """Poetry config file handler parsed from pyproject.toml."""
 
     def __init__(
-        self, path: Path, *, section: List[str], model_cls, direct_mappings=None
+        self,
+        path: Path,
+        *,
+        section: List[str],
+        model_cls,
+        direct_mappings=None,
+        pass_validation: Optional[bool] = False,
     ):
         """Poetry config file handler parsed from pyproject.toml.
 
@@ -30,7 +36,10 @@ def __init__(
         self._model_cls = model_cls
         self._section = section
         super().__init__(
-            path, create_if_not_exists=False, direct_mappings=direct_mappings or {}
+            path,
+            create_if_not_exists=False,
+            direct_mappings=direct_mappings or {},
+            pass_validation=pass_validation,
         )
 
     def _load(self) -> None:
@@ -44,6 +53,8 @@ def _validate(self) -> None:
         In order to preserve toml comments and structure, tomlkit library is used.
         Pydantic class only used for validation.
         """
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {self._model_cls.__name__}: {pretty_repr(config)}"
@@ -89,12 +100,21 @@ def _set_property(self, key: Union[str, List[str], IgnoreKey], value: Any) -> No
 class Poetry(PyprojectCommon):
     """Poetry config file handler parsed from pyproject.toml."""
 
-    def __init__(self, path: Path):
+    def __init__(
+        self,
+        path: Path,
+        pass_validation: Optional[bool] = False,
+    ):
         """Poetry config file handler parsed from pyproject.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
         """
-        super().__init__(path, section=["tool", "poetry"], model_cls=PoetryConfig)
+        super().__init__(
+            path,
+            section=["tool", "poetry"],
+            model_cls=PoetryConfig,
+            pass_validation=pass_validation,
+        )
 
     @staticmethod
     def _from_person(person: Union[Person, Entity]):
@@ -119,7 +139,7 @@ def _to_person(person: str) -> Optional[Union[Person, Entity]]:
 class SetupTools(PyprojectCommon):
     """Setuptools config file handler parsed from setup.cfg."""
 
-    def __init__(self, path: Path):
+    def __init__(self, path: Path, pass_validation: Optional[bool] = False):
         """Setuptools config file handler parsed from pyproject.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
@@ -132,7 +152,11 @@ def __init__(self, path: Path):
             "license": ["license", "text"],
         }
         super().__init__(
-            path, section=section, direct_mappings=mappings, model_cls=SetuptoolsConfig
+            path,
+            section=section,
+            direct_mappings=mappings,
+            model_cls=SetuptoolsConfig,
+            pass_validation=pass_validation,
         )
 
     @staticmethod
@@ -186,11 +210,12 @@ class Pyproject(wrapt.ObjectProxy):
 
     __wrapped__: Union[SetupTools, Poetry]
 
-    def __init__(self, path: Path):
+    def __init__(self, path: Path, pass_validation: Optional[bool] = False):
         """Pyproject wrapper class. Wraps either setuptools or poetry.
 
         Args:
             path (Path): Path to pyproject.toml file.
+            pass_validation (bool, optional): Whether to pass validation. Defaults to False.
 
         Raises:
             FileNotFoundError: Raised when pyproject.toml file is not found.
@@ -207,10 +232,10 @@ def __init__(self, path: Path):
         # inspect file to pick suitable project metadata writer
         if "project" in data:
             logger.verbose("Found setuptools-based metadata in pyproject.toml")
-            self.__wrapped__ = SetupTools(path)
+            self.__wrapped__ = SetupTools(path, pass_validation=pass_validation)
         elif "tool" in data and "poetry" in data["tool"]:
             logger.verbose("Found poetry-based metadata in pyproject.toml")
-            self.__wrapped__ = Poetry(path)
+            self.__wrapped__ = Poetry(path, pass_validation=pass_validation)
         else:
             msg = "The pyproject.toml file is ambiguous, either add a [project] or [tool.poetry] section"
             raise ValueError(msg)

src/somesy/rust/writer.py

@@ -18,7 +18,11 @@
 class Rust(ProjectMetadataWriter):
     """Rust config file handler parsed from Cargo.toml."""
 
-    def __init__(self, path: Path):
+    def __init__(
+        self,
+        path: Path,
+        pass_validation: Optional[bool] = False,
+    ):
         """Rust config file handler parsed from Cargo.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
@@ -27,7 +31,12 @@ def __init__(self, path: Path):
         mappings: FieldKeyMapping = {
             "maintainers": IgnoreKey(),
         }
-        super().__init__(path, create_if_not_exists=False, direct_mappings=mappings)
+        super().__init__(
+            path,
+            create_if_not_exists=False,
+            direct_mappings=mappings,
+            pass_validation=pass_validation,
+        )
 
     def _load(self) -> None:
         """Load Cargo.toml file."""
@@ -40,6 +49,8 @@ def _validate(self) -> None:
         In order to preserve toml comments and structure, tomlkit library is used.
         Pydantic class only used for validation.
         """
+        if self.pass_validation:
+            return
         config = dict(self._get_property([]))
         logger.debug(
             f"Validating config using {RustConfig.__name__}: {pretty_repr(config)}"

tests/input/test_cff_validate.py

@@ -25,3 +25,6 @@ def test_cff_validate_reject(tmp_path):
     # try to load the CFF file
     with pytest.raises(ValueError):
         CFF(cff_path)
+
+    # if we pass validation, it should not raise an error
+    CFF(cff_path, pass_validation=True)