Merge pull request #115 from Materials-Data-Science-and-Informatics/feature/poetryv2

Feature/poetryv2

Author: mustafasoylu

.somesy.toml

@@ -1,6 +1,6 @@
 [project]
 name = "somesy"
-version = "0.6.0"
+version = "0.7.0"
 description = "A CLI tool for synchronizing software project metadata."
 keywords = ["metadata", "FAIR"]
 license = "MIT"

CHANGELOG.md

@@ -4,13 +4,14 @@ Here we provide notes that summarize the most important changes in each released
 
 Please consult the changelog to inform yourself about breaking changes and security issues.
 
-## [v0.7.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.7.0) <small>(2025-xx-xx)</small> { id="0.7.0" }
+## [v0.7.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.7.0) <small>(2025-03-04)</small> { id="0.7.0" }
 
 - make validation of output files, such as pyproject.toml, optional
 - make somesy project metadata input `version` optional
 - multiple output file support
 - enable having packages support
 - fix: package.json url set error on None value
+- support poetry version 2
 
 ## [v0.6.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.6.0) <small>(2025-02-14)</small> { id="0.6.0" }
 

CITATION.cff

@@ -3,7 +3,7 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: somesy
-version: 0.6.0
+version: 0.7.0
 abstract: A CLI tool for synchronizing software project metadata.
 url: https://materials-data-science-and-informatics.github.io/somesy
 repository-code: https://github.com/Materials-Data-Science-and-Informatics/somesy

README.md

@@ -56,6 +56,10 @@ Starting with version **0.3.0**, `somesy` supports Linux, MacOS and Windows.
 
 Make sure that you use the latest version in order to avoid any problems.
 
+! info
+
+    Poetry changed location of its project metadata with its version 2. Starting with version **0.7.0**, `somesy` supports both major versions of `poetry`, version 1 and 2.
+
 ### Installing somesy
 
 Somesy requires Python `>=3.8`. To get a first impression, you can install the
@@ -172,7 +176,7 @@ file in the root folder of your repository:
 repos:
     # ... (your other hooks) ...
     - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
-      rev: 'v0.6.0'
+      rev: 'v0.7.0'
       hooks:
           - id: somesy
 ```
@@ -193,18 +197,18 @@ so when using `somesy` with pre-commit, keep in mind that
 
 Here is an overview of all the currently supported files and formats.
 
-| Input Formats  | Status |     | Target Formats                | Status |
-| -------------- | ------ | --- | ----------------------------- | ------ |
-| (.)somesy.toml | ✓      |     | pyproject.toml _(poetry)_     | ✓      |
-| pyproject.toml | ✓      |     | pyproject.toml _(setuptools)_ | ✓(1.)  |
-| package.json   | ✓      |     | package.json _(JavaScript)_   | ✓(2.)  |
-| Project.toml   | ✓      |     | Project.toml _(Julia)_        | ✓      |
-| fpm.toml       | ✓      |     | fpm.toml _(Fortran)_          | ✓(3.)  |
-|                | ✓      |     | pom.toml _(Java)_             | ✓(4.)  |
-| Cargo.toml     | ✓      |     | Cargo.toml _(Rust)_           | ✓      |
-|                |        |     | mkdocs.yml                    | ✓(5.)  |
-|                |        |     | CITATION.cff                  | ✓      |
-|                |        |     | codemeta.json                 | ✓(6.)  |
+| Input Formats  | Status |     | Target Formats                      | Status |
+| -------------- | ------ | --- | ----------------------------------- | ------ |
+| (.)somesy.toml | ✓      |     | pyproject.toml _(poetry v1 and v2)_ | ✓      |
+| pyproject.toml | ✓      |     | pyproject.toml _(setuptools)_       | ✓(1.)  |
+| package.json   | ✓      |     | package.json _(JavaScript)_         | ✓(2.)  |
+| Project.toml   | ✓      |     | Project.toml _(Julia)_              | ✓      |
+| fpm.toml       | ✓      |     | fpm.toml _(Fortran)_                | ✓(3.)  |
+|                | ✓      |     | pom.toml _(Java)_                   | ✓(4.)  |
+| Cargo.toml     | ✓      |     | Cargo.toml _(Rust)_                 | ✓      |
+|                |        |     | mkdocs.yml                          | ✓(5.)  |
+|                |        |     | CITATION.cff                        | ✓      |
+|                |        |     | codemeta.json                       | ✓(6.)  |
 
 **Notes:**
 

codemeta.json

@@ -27,7 +27,7 @@
   ],
   "name": "somesy",
   "description": "A CLI tool for synchronizing software project metadata.",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "keywords": [
     "metadata",
     "FAIR"

docs/manual.md

@@ -225,7 +225,7 @@ one of the supported input formats:
 === "pyproject.toml"
 
     ```toml
-    [tool.poetry]
+    [tool.poetry] # [project] in case of poetry version 2
     name = "my-amazing-project"
     version = "0.1.0"
     ...

pyproject.toml

@@ -1,25 +1,29 @@
-[tool.poetry]
+[project]
 name = "somesy"
-version = "0.6.0"
+version = "0.7.0"
 description = "A CLI tool for synchronizing software project metadata."
-authors = ["Mustafa Soylu <m.soylu@fz-juelich.de>", "Anton Pirogov <a.pirogov@fz-juelich.de>"]
-maintainers = ["Mustafa Soylu <m.soylu@fz-juelich.de>"]
 license = "MIT"
-
 readme = "README.md"
-repository = "https://github.com/Materials-Data-Science-and-Informatics/somesy"
-homepage = "https://materials-data-science-and-informatics.github.io/somesy"
-documentation = "https://materials-data-science-and-informatics.github.io/somesy"
-
 keywords = ["metadata", "FAIR"]
 classifiers = [
     "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Natural Language :: English",
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Topic :: Software Development :: Libraries :: Application Frameworks",
     "License :: OSI Approved :: MIT License",
 ]
 
+authors = [{name = "Mustafa Soylu", email = "m.soylu@fz-juelich.de"}, {name = "Anton Pirogov", email = "a.pirogov@fz-juelich.de"}]
+maintainers = [{name = "Mustafa Soylu", email = "m.soylu@fz-juelich.de"}]
+[project.urls]
+homepage = "https://materials-data-science-and-informatics.github.io/somesy"
+repository = "https://github.com/Materials-Data-Science-and-Informatics/somesy"
+documentation = "https://materials-data-science-and-informatics.github.io/somesy"
+
+[tool.poetry]
 # the Python packages that will be included in a built distribution:
 packages = [{include = "somesy", from = "src"}]
 

src/somesy/core/writer.py

@@ -251,6 +251,10 @@ def _sync_person_list(
 
         """
         old_people: List[Union[Person, Entity]] = self._parse_people(old)
+        if old_people is None or len(old_people) == 0:
+            return new
+        if new is None or len(new) == 0:
+            return old_people
         return self._merge_person_metadata(old_people, new)
 
     def _sync_authors(self, metadata: ProjectMetadata) -> None:
@@ -259,7 +263,10 @@ def _sync_authors(self, metadata: ProjectMetadata) -> None:
         This method is existing for the publication_author special case
         when synchronizing to CITATION.cff.
         """
-        self.authors = self._sync_person_list(self.authors, metadata.authors())
+        if self.authors is None or len(self.authors) == 0:
+            self.authors = metadata.authors()
+        else:
+            self.authors = self._sync_person_list(self.authors, metadata.authors())
 
     def sync(self, metadata: ProjectMetadata) -> None:
         """Sync output file with other metadata files."""
@@ -301,7 +308,7 @@ def _parse_people(cls, people: Optional[List[Any]]) -> List[Union[Person, Entity
         # remove None values
         people = [p for p in people if p is not None]
 
-        people = list(map(cls._to_person, people or []))
+        people = list(map(lambda p: cls._to_person(p), people or []))
         return people
 
     # ----
@@ -345,7 +352,7 @@ def description(self, description: str) -> None:
     def authors(self):
         """Return the authors of the project."""
         authors = self._get_property(self._get_key("authors"))
-        if authors is None:
+        if authors is None or len(authors) == 0:
             return []
 
         # only return authors that can be converted to Person

src/somesy/pyproject/models.py

@@ -24,6 +24,13 @@
 logger = getLogger("somesy")
 
 
+class STPerson(BaseModel):
+    """Person model for setuptools."""
+
+    name: Annotated[str, Field(min_length=1)]
+    email: Annotated[Optional[str], Field(min_length=1)] = None
+
+
 class PoetryConfig(BaseModel):
     """Poetry configuration model."""
 
@@ -45,10 +52,13 @@ class PoetryConfig(BaseModel):
         Optional[Union[LicenseEnum, List[LicenseEnum]]],
         Field(description="An SPDX license identifier."),
     ]
-    authors: Annotated[Set[str], Field(description="Package authors")]
+
+    # v1 has str, v2 has STPerson
+    authors: Annotated[List[Union[str, STPerson]], Field(description="Package authors")]
     maintainers: Annotated[
-        Optional[Set[str]], Field(description="Package maintainers")
+        Optional[List[Union[str, STPerson]]], Field(description="Package maintainers")
     ] = None
+
     readme: Annotated[
         Optional[Union[Path, List[Path]]], Field(description="Package readme file(s)")
     ] = None
@@ -90,10 +100,17 @@ def validate_email_format(cls, v):
         validated = []
         for author in v:
             try:
-                if not (
-                    not isinstance(author, str)
-                    or " " not in author
-                    or not EMailAddress.validate_python(author.split(" ")[-1][1:-1])
+                if isinstance(author, STPerson) and author.email:
+                    if not EMailAddress.validate_python(author.email):
+                        logger.warning(
+                            f"Invalid email format for author/maintainer {author}, omitting."
+                        )
+                    else:
+                        validated.append(author)
+                        continue
+
+                if " " in author and EMailAddress.validate_python(
+                    author.split(" ")[-1][1:-1]
                 ):
                     validated.append(author)
                 else:
@@ -150,13 +167,6 @@ def validate_xor(cls, values):
         return values
 
 
-class STPerson(BaseModel):
-    """Person model for setuptools."""
-
-    name: Annotated[str, Field(min_length=1)]
-    email: Annotated[Optional[str], Field(min_length=1)] = None
-
-
 class URLs(BaseModel):
     """URLs model for setuptools."""
 

src/somesy/pyproject/writer.py

@@ -2,7 +2,7 @@
 
 import logging
 from pathlib import Path
-from typing import Any, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 import tomlkit
 import wrapt
@@ -104,26 +104,55 @@ def __init__(
         self,
         path: Path,
         pass_validation: Optional[bool] = False,
+        version: Optional[int] = 1,
     ):
         """Poetry config file handler parsed from pyproject.toml.
 
         See [somesy.core.writer.ProjectMetadataWriter.__init__][].
         """
-        super().__init__(
-            path,
-            section=["tool", "poetry"],
-            model_cls=PoetryConfig,
-            pass_validation=pass_validation,
-        )
+        self._poetry_version = version
+        v2_mappings = {
+            "homepage": ["urls", "homepage"],
+            "repository": ["urls", "repository"],
+            "documentation": ["urls", "documentation"],
+        }
+        if version == 1:
+            super().__init__(
+                path,
+                section=["tool", "poetry"],
+                model_cls=PoetryConfig,
+                pass_validation=pass_validation,
+            )
+        else:
+            super().__init__(
+                path,
+                section=["project"],
+                model_cls=PoetryConfig,
+                pass_validation=pass_validation,
+                direct_mappings=v2_mappings,
+            )
 
     @staticmethod
-    def _from_person(person: Union[Person, Entity]):
+    def _from_person(person: Union[Person, Entity], poetry_version: int = 1):
         """Convert project metadata person object to poetry string for person format "full name <email>."""
-        return person.to_name_email_string()
+        if poetry_version == 1:
+            return person.to_name_email_string()
+        else:
+            response = {"name": person.full_name}
+            if person.email:
+                response["email"] = person.email
+            return response
 
     @staticmethod
-    def _to_person(person: str) -> Optional[Union[Person, Entity]]:
+    def _to_person(
+        person: Union[str, Dict[str, str]],
+    ) -> Optional[Union[Person, Entity]]:
         """Convert from free string to person or entity object."""
+        if isinstance(person, dict):
+            temp = str(person["name"])
+            if "email" in person:
+                temp = f"{temp} <{person['email']}>"
+            person = temp
         try:
             return Person.from_name_email_string(person)
         except (ValueError, AttributeError):
@@ -135,6 +164,41 @@ def _to_person(person: str) -> Optional[Union[Person, Entity]]:
             logger.warning(f"Cannot convert {person} to Entity.")
             return None
 
+    def sync(self, metadata: ProjectMetadata) -> None:
+        """Sync metadata with pyproject.toml file."""
+        # Store original _from_person method
+        original_from_person = self._from_person
+
+        # Override _from_person to include poetry_version
+        self._from_person = lambda person: original_from_person(  # type: ignore
+            person, poetry_version=self._poetry_version
+        )
+
+        # Call parent sync method
+        super().sync(metadata)
+
+        # Restore original _from_person method
+        self._from_person = original_from_person  # type: ignore
+
+        # For Poetry v2, convert authors and maintainers from array of tables to inline tables
+        if self._poetry_version == 2:
+            for field in ["authors", "maintainers"]:
+                field_value = self._get_property([field])
+                if field_value:
+                    # Create an inline array of tables
+                    inline_array = tomlkit.array()
+                    inline_array.multiline(False)
+
+                    # Convert each table to an inline table and add to array
+                    for item in field_value:
+                        inline_table = tomlkit.inline_table()
+                        for k, v in item.items():
+                            inline_table[k] = v
+                        inline_array.append(inline_table)
+
+                    # Replace the array of tables with the inline array
+                    self._set_property(field, inline_array)
+
 
 class SetupTools(PyprojectCommon):
     """Setuptools config file handler parsed from setup.cfg."""
@@ -230,14 +294,24 @@ def __init__(self, path: Path, pass_validation: Optional[bool] = False):
             data = load(f)
 
         # inspect file to pick suitable project metadata writer
-        if "project" in data:
+        is_poetry = "tool" in data and "poetry" in data["tool"]
+        has_project = "project" in data
+
+        if is_poetry:
+            if has_project:
+                logger.verbose(
+                    "Found Poetry 2.x metadata with project section in pyproject.toml"
+                )
+            else:
+                logger.verbose("Found Poetry 1.x metadata in pyproject.toml")
+            self.__wrapped__ = Poetry(
+                path, pass_validation=pass_validation, version=2 if has_project else 1
+            )
+        elif has_project and not is_poetry:
             logger.verbose("Found setuptools-based metadata in pyproject.toml")
             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, pass_validation=pass_validation)
         else:
-            msg = "The pyproject.toml file is ambiguous, either add a [project] or [tool.poetry] section"
+            msg = "The pyproject.toml file is ambiguous. For Poetry projects, ensure [tool.poetry] section exists. For setuptools, ensure [project] section exists without [tool.poetry]"
             raise ValueError(msg)
 
         super().__init__(self.__wrapped__)