Skip to content

models

Pyproject models.

STPerson

Bases: BaseModel

Person model for PEP 621 [project] metadata.

Source code in src/somesy/pyproject/models.py 
50
51
52
53
54
55
56
57
58
59
60
61
class STPerson(BaseModel):
    """Person model for PEP 621 `[project]` metadata."""

    name: Annotated[str, Field(min_length=1)]
    email: Annotated[str | None, Field(min_length=1)] = None

    def __str__(self):
        """Return string representation of STPerson."""
        if self.email:
            return f"{self.name} <{self.email}>"
        else:
            return self.name

__str__ 

__str__()

Return string representation of STPerson.

Source code in src/somesy/pyproject/models.py 
56
57
58
59
60
61
def __str__(self):
    """Return string representation of STPerson."""
    if self.email:
        return f"{self.name} <{self.email}>"
    else:
        return self.name

License

Bases: BaseModel

License model for PEP 621 [project] metadata.

Source code in src/somesy/pyproject/models.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
class License(BaseModel):
    """License model for PEP 621 `[project]` metadata."""

    model_config = {"validate_assignment": True}

    file: Path | None = None
    text: LicenseEnum | None = None

    @model_validator(mode="before")
    @classmethod
    def validate_xor(cls, values):
        """Validate that only one of file or text is set."""
        # check if this has just str or list of str
        if isinstance(values, str):
            if values in LicenseEnum.__members__:
                return {"text": values}
            else:
                raise ValueError("Invalid license.")
        if isinstance(values, list):
            # check if all elements are valid string for LicenseEnum
            for v in values:
                if not isinstance(v, str):
                    raise TypeError("All elements must be strings.")
                if v not in LicenseEnum.__members__:
                    raise ValueError("Invalid license.")
            return values
        if sum([bool(v) for v in values.values()]) != 1:
            raise ValueError("Either file or text must be set.")
        return values

validate_xor classmethod 

validate_xor(values)

Validate that only one of file or text is set.

Source code in src/somesy/pyproject/models.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
@model_validator(mode="before")
@classmethod
def validate_xor(cls, values):
    """Validate that only one of file or text is set."""
    # check if this has just str or list of str
    if isinstance(values, str):
        if values in LicenseEnum.__members__:
            return {"text": values}
        else:
            raise ValueError("Invalid license.")
    if isinstance(values, list):
        # check if all elements are valid string for LicenseEnum
        for v in values:
            if not isinstance(v, str):
                raise TypeError("All elements must be strings.")
            if v not in LicenseEnum.__members__:
                raise ValueError("Invalid license.")
        return values
    if sum([bool(v) for v in values.values()]) != 1:
        raise ValueError("Either file or text must be set.")
    return values

PoetryConfig

Bases: BaseModel

Poetry configuration model.

Source code in src/somesy/pyproject/models.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
class PoetryConfig(BaseModel):
    """Poetry configuration model."""

    model_config = {"use_enum_values": True}

    name: Annotated[
        str,
        Field(pattern=_PACKAGE_NAME_PATTERN, description="Package name"),
    ]
    version: Annotated[
        str | None,
        Field(
            default=None,
            pattern=r"^\d+(\.\d+)*((a|b|rc)\d+)?(post\d+)?(dev\d+)?$",
            description="Package version",
        ),
    ]
    description: Annotated[
        str | None, Field(default=None, description="Package description")
    ]
    dynamic: Annotated[
        list[str] | None, Field(default=None, description="PEP 621 dynamic fields")
    ]

    @model_validator(mode="after")
    def validate_required_unless_dynamic(self):
        """Validate that version and description are present unless listed in dynamic."""
        return _check_required_unless_dynamic(self)

    license: Annotated[
        LicenseEnum | list[LicenseEnum] | License | str | None,
        Field(description="An SPDX license identifier."),
    ] = None

    # v1 has str, v2 has STPerson
    authors: Annotated[list[str | STPerson], Field(description="Package authors")]
    maintainers: Annotated[
        list[str | STPerson] | None, Field(description="Package maintainers")
    ] = None

    readme: Annotated[
        Path | list[Path] | None, Field(description="Package readme file(s)")
    ] = None
    homepage: Annotated[HttpUrlStr | None, Field(description="Package homepage")] = None
    repository: Annotated[
        HttpUrlStr | None, Field(description="Package repository")
    ] = None
    documentation: Annotated[
        HttpUrlStr | None, Field(description="Package documentation page")
    ] = None
    keywords: Annotated[
        set[str] | None, Field(description="Keywords that describe the package")
    ] = None
    classifiers: Annotated[list[str] | None, Field(description="pypi classifiers")] = (
        None
    )
    urls: Annotated[dict[str, HttpUrlStr] | None, Field(description="Package URLs")] = (
        None
    )

    @field_validator("version")
    @classmethod
    def validate_version(cls, v):
        """Validate version using PEP 440."""
        return _check_version(v)

    @field_validator("authors", "maintainers")
    @classmethod
    def validate_email_format(cls, v):
        """Validate person format, raise on invalid emails and drop duplicate persons."""
        if v is None:
            return []
        validated = []
        seen = set()
        for author in v:
            if isinstance(author, STPerson) and author.email:
                EMailAddress.validate_python(author.email)
            elif isinstance(author, str) and "@" in author:
                EMailAddress.validate_python(author.split(" ")[-1][1:-1])
            author_str = str(author)
            if author_str not in seen:
                seen.add(author_str)
                validated.append(author)
            else:
                logger.warning(f"Same person {author} is added multiple times.")

        return validated

    @field_validator("readme")
    @classmethod
    def validate_readme(cls, v):
        """Validate readme file(s) by checking whether files exist."""
        if isinstance(v, list):
            if any(not e.is_file() for e in v):
                logger.warning("Some readme file(s) do not exist")
        else:
            if not v.is_file():
                logger.warning("Readme file does not exist")
        return v

validate_required_unless_dynamic 

validate_required_unless_dynamic()

Validate that version and description are present unless listed in dynamic.

Source code in src/somesy/pyproject/models.py 
119
120
121
122
@model_validator(mode="after")
def validate_required_unless_dynamic(self):
    """Validate that version and description are present unless listed in dynamic."""
    return _check_required_unless_dynamic(self)

validate_version classmethod 

validate_version(v)

Validate version using PEP 440.

Source code in src/somesy/pyproject/models.py 
155
156
157
158
159
@field_validator("version")
@classmethod
def validate_version(cls, v):
    """Validate version using PEP 440."""
    return _check_version(v)

validate_email_format classmethod 

validate_email_format(v)

Validate person format, raise on invalid emails and drop duplicate persons.

Source code in src/somesy/pyproject/models.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
@field_validator("authors", "maintainers")
@classmethod
def validate_email_format(cls, v):
    """Validate person format, raise on invalid emails and drop duplicate persons."""
    if v is None:
        return []
    validated = []
    seen = set()
    for author in v:
        if isinstance(author, STPerson) and author.email:
            EMailAddress.validate_python(author.email)
        elif isinstance(author, str) and "@" in author:
            EMailAddress.validate_python(author.split(" ")[-1][1:-1])
        author_str = str(author)
        if author_str not in seen:
            seen.add(author_str)
            validated.append(author)
        else:
            logger.warning(f"Same person {author} is added multiple times.")

    return validated

validate_readme classmethod 

validate_readme(v)

Validate readme file(s) by checking whether files exist.

Source code in src/somesy/pyproject/models.py 
183
184
185
186
187
188
189
190
191
192
193
@field_validator("readme")
@classmethod
def validate_readme(cls, v):
    """Validate readme file(s) by checking whether files exist."""
    if isinstance(v, list):
        if any(not e.is_file() for e in v):
            logger.warning("Some readme file(s) do not exist")
    else:
        if not v.is_file():
            logger.warning("Readme file does not exist")
    return v

ContentTypeEnum

Bases: Enum

Content type enum for the PEP 621 readme file field.

Source code in src/somesy/pyproject/models.py 
196
197
198
199
200
201
class ContentTypeEnum(Enum):
    """Content type enum for the PEP 621 readme file field."""

    plain = "text/plain"
    rst = "text/x-rst"
    markdown = "text/markdown"

File

Bases: BaseModel

File model for PEP 621 [project] metadata.

Source code in src/somesy/pyproject/models.py 
204
205
206
207
208
class File(BaseModel):
    """File model for PEP 621 `[project]` metadata."""

    file: Path
    content_type: ContentTypeEnum | None = Field(alias="content-type")

URLs

Bases: BaseModel

URLs model for PEP 621 [project] metadata.

Source code in src/somesy/pyproject/models.py 
211
212
213
214
215
216
217
class URLs(BaseModel):
    """URLs model for PEP 621 `[project]` metadata."""

    homepage: HttpUrlStr | None = None
    repository: HttpUrlStr | None = None
    documentation: HttpUrlStr | None = None
    changelog: HttpUrlStr | None = None

Pep621Config

Bases: BaseModel

PEP 621 [project] input model, as written by uv, hatchling, flit, PDM, setuptools and Poetry 2.x.

Required fields are name, and version and description unless listed as dynamic.

Source code in src/somesy/pyproject/models.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
class Pep621Config(BaseModel):
    """PEP 621 `[project]` input model, as written by uv, hatchling, flit, PDM, setuptools and Poetry 2.x.

    Required fields are name, and version and description unless listed as dynamic.
    """

    model_config = {"use_enum_values": True}

    name: Annotated[str, Field(pattern=_PACKAGE_NAME_PATTERN)]
    version: Annotated[
        str | None,
        Field(
            default=None,
            pattern=r"^\d+(\.\d+)*((a|b|rc)\d+)?(post\d+)?(dev\d+)?$",
        ),
    ]
    description: str | None = None
    dynamic: Annotated[
        list[str] | None, Field(default=None, description="PEP 621 dynamic fields")
    ]

    @model_validator(mode="after")
    def validate_required_unless_dynamic(self):
        """Validate that version and description are present unless listed in dynamic."""
        return _check_required_unless_dynamic(self)

    readme: Path | list[Path] | File | None = None
    license: License | LicenseEnum | str | None = Field(
        None, description="An SPDX license identifier."
    )
    authors: list[STPerson] | None = None
    maintainers: list[STPerson] | None = None
    keywords: set[str] | None = None
    classifiers: list[str] | None = None
    urls: URLs | None = None

    @field_validator("version")
    @classmethod
    def validate_version(cls, v):
        """Validate version using PEP 440."""
        return _check_version(v)

    @field_validator("readme")
    @classmethod
    def validate_readme(cls, v):
        """Validate readme file(s) by checking whether files exist."""
        if isinstance(v, list):
            if any(not e.is_file() for e in v):
                logger.warning("Some readme file(s) do not exist")
        elif type(v) is File:
            if not Path(v.file).is_file():
                logger.warning("Readme file does not exist")
        else:
            if not v.is_file():
                logger.warning("Readme file does not exist")
        return v

    @field_validator("authors", "maintainers")
    @classmethod
    def validate_email_format(cls, v):
        """Validate email format."""
        for person in v:
            if person.email and not EMailAddress.validate_python(person.email):
                raise ValueError("Invalid email format")
        return v

validate_required_unless_dynamic 

validate_required_unless_dynamic()

Validate that version and description are present unless listed in dynamic.

Source code in src/somesy/pyproject/models.py 
241
242
243
244
@model_validator(mode="after")
def validate_required_unless_dynamic(self):
    """Validate that version and description are present unless listed in dynamic."""
    return _check_required_unless_dynamic(self)

validate_version classmethod 

validate_version(v)

Validate version using PEP 440.

Source code in src/somesy/pyproject/models.py 
256
257
258
259
260
@field_validator("version")
@classmethod
def validate_version(cls, v):
    """Validate version using PEP 440."""
    return _check_version(v)

validate_readme classmethod 

validate_readme(v)

Validate readme file(s) by checking whether files exist.

Source code in src/somesy/pyproject/models.py 
262
263
264
265
266
267
268
269
270
271
272
273
274
275
@field_validator("readme")
@classmethod
def validate_readme(cls, v):
    """Validate readme file(s) by checking whether files exist."""
    if isinstance(v, list):
        if any(not e.is_file() for e in v):
            logger.warning("Some readme file(s) do not exist")
    elif type(v) is File:
        if not Path(v.file).is_file():
            logger.warning("Readme file does not exist")
    else:
        if not v.is_file():
            logger.warning("Readme file does not exist")
    return v

validate_email_format classmethod 

validate_email_format(v)

Validate email format.

Source code in src/somesy/pyproject/models.py 
277
278
279
280
281
282
283
284
@field_validator("authors", "maintainers")
@classmethod
def validate_email_format(cls, v):
    """Validate email format."""
    for person in v:
        if person.email and not EMailAddress.validate_python(person.email):
            raise ValueError("Invalid email format")
    return v