Optional email (#102)

* make email optional in the person model

* remove none's from the existing people list

* make email optional in setuptools model

* remove check of no email value since it is done in core now

* update tests for optional email

* show email is optional in manual

* update doc dev docs for ruff usage

Author: mustafasoylu

docs/dev_guide.md

@@ -52,9 +52,7 @@ Best practices for modern Python development are implemented by using:
 * `pytest` for unit testing
 * `hypothesis` for property-based testing
 * `pre-commit` for orchestrating linters, formatters and other utilities
-* `black` for source-code formatting
-* `autoflake` for automatically removing unused imports
-* `flake8` for general linting (using various linter plugins)
+* `ruff` for source-code formatting and for general linting
 * `pydocstyle` for checking docstring conventions
 * `interrogate` for computing docstring coverage
 * `mypy` for editor-independent type-checking

docs/manual.md

@@ -117,12 +117,12 @@ some of the currently supported formats. Bold field names are mandatory, the oth
 
 === "Person Metadata"
 
-    | Somesy Field     | Poetry Config | SetupTools Config | Java POM     | Julia Config | Fortran Config | package.json | mkdocs.yml | Rust Config    | CITATION.cff    | CodeMeta        |
+    | Somesy Field     | Poetry Config | SetupTools Config | Java POM     | Julia Config | Fortran Config | package.json | mkdocs.yml | Rust Config    | CITATION.cff    | CodeMeta       |
     | ---------------- | ------------- | ----------------- | ------------ | ------------ | -------------- | ------------ | ---------- | -------------- | --------------- | -------------- |
     |                  |               |                   |              |              |                |              |            |                |                 |                |
     | **given-names**  | name+email    | name              | name         | name+email   | name+email     | name         | name+email | name+email     | givenName       | name+email     |
     | **family-names** | name+email    | name              | name         | name+email   | name+email     | name         | name+email | name+email     | familyName      | name+email     |
-    | **email**        | name+email    | email             | email        | name+email   | name+email     | email        | name+email | name+email     | email           | name+email     |
+    | email            | name+email    | email             | email        | name+email   | name+email     | email        | name+email | name+email     | email           | name+email     |
     | orcid            | -             | -                 | url          | -            | -              | url          | -          | -              | id              | -              |
     | *(many others)*  | -             | -                 | -            | -            | -              | -            | -          | -              | *(same)*        | -              |
 

src/somesy/core/models.py

@@ -274,12 +274,12 @@ class Person(SomesyBaseModel):
     ] = None
 
     email: Annotated[
-        str,
+        Optional[str],
         Field(
             pattern=r"^[\S]+@[\S]+\.[\S]{2,}$",
             description="The person's email address.",
         ),
-    ]
+    ] = None
 
     family_names: Annotated[
         str, Field(alias="family-names", description="The person's family names.")
@@ -400,7 +400,10 @@ def full_name(self) -> str:
 
     def to_name_email_string(self) -> str:
         """Convert project metadata person object to poetry string for person format `full name <x@y.z>`."""
-        return f"{self.full_name} <{self.email}>"
+        if self.email:
+            return f"{self.full_name} <{self.email}>"
+        else:
+            return self.full_name
 
     @classmethod
     def from_name_email_string(cls, person: str) -> Person:
@@ -409,6 +412,14 @@ def from_name_email_string(cls, person: str) -> Person:
         If the name is `A B C`, then `A B` will be the given names and `C` will be the family name.
         """
         m = re.match(r"\s*([^<]+)<([^>]+)>", person)
+        if m is None:
+            names = list(map(lambda s: s.strip(), person.split()))
+            return Person(
+                **{
+                    "given-names": " ".join(names[:-1]),
+                    "family-names": names[-1],
+                }
+            )
         names, mail = (
             list(map(lambda s: s.strip(), m.group(1).split())),
             m.group(2).strip(),

src/somesy/core/writer.py

@@ -290,7 +290,11 @@ def _to_person(person_obj: Any) -> Person:
     @classmethod
     def _parse_people(cls, people: Optional[List[Any]]) -> List[Person]:
         """Return a list of Persons parsed from list of format-specific people representations."""
-        return list(map(cls._to_person, people or []))
+        # remove None values
+        people = [p for p in people if p is not None]
+
+        people = list(map(cls._to_person, people or []))
+        return people
 
     # ----
     # individual magic getters and setters

src/somesy/pyproject/models.py

@@ -154,7 +154,7 @@ class STPerson(BaseModel):
     """Person model for setuptools."""
 
     name: Annotated[str, Field(min_length=1)]
-    email: Annotated[str, Field(min_length=1)]
+    email: Annotated[Optional[str], Field(min_length=1)] = None
 
 
 class URLs(BaseModel):

src/somesy/rust/writer.py

@@ -91,10 +91,7 @@ def _from_person(person: Person):
     @staticmethod
     def _to_person(person_obj: str) -> Optional[Person]:
         """Parse rust person string to a Person. It has format "full name <email>." but email is optional."""
-        try:
-            return Person.from_name_email_string(person_obj)
-        except (ValueError, AttributeError):
-            return None
+        return Person.from_name_email_string(person_obj)
 
     @classmethod
     def _parse_people(cls, people: Optional[List[Any]]) -> List[Person]:

tests/output/test_julia_writer.py

@@ -131,7 +131,8 @@ def test_without_email(tmp_path, person):
     # load and sync
     pj = Julia(project_file)
 
-    assert len(pj.authors) == 0
+    assert len(pj.authors) == 1
+    assert pj.authors[0] == person.full_name
 
     pm = ProjectMetadata(
         name="My awesome project",

tests/output/test_mkdocs_writer.py

@@ -13,7 +13,7 @@ def mkdocs(load_files, file_types):
 def test_content_match(mkdocs: MkDocs):
     assert mkdocs.name == "test-package"
     assert mkdocs.description == "This is a test package for demonstration purposes."
-    assert len(mkdocs.authors) == 0
+    assert len(mkdocs.authors) == 1
 
 
 def test_sync(mkdocs: MkDocs, somesy_input: dict):

tests/output/test_pyproject_writer.py

@@ -79,7 +79,8 @@ def test_from_to_person(person):
 
     # this should return None since there is no email
     p = Poetry._to_person("John Doe")
-    assert p is None
+    assert p.given_names == "John"
+    assert p.family_names == "Doe"
 
     # test for setuptools
     assert SetupTools._from_person(person) == {
@@ -195,7 +196,7 @@ def test_without_email(tmp_path, person):
 
     # load and sync
     p = Poetry(pyproject_file)
-    assert len(p.authors) == 0
+    assert len(p.authors) == 1
 
     pm = ProjectMetadata(
         name="My awesome project",

tests/output/test_rust_writer.py

@@ -47,7 +47,9 @@ def test_from_to_person(person):
     assert p.email == person.email
 
     # rust also has only name format
-    assert Rust._to_person(person.full_name) == None
+    converted_person = Rust._to_person(person.full_name)
+    assert converted_person.given_names == person.given_names
+    assert converted_person.family_names == person.family_names
 
 
 def test_person_merge(rust_file, person):