Skip to content

models

Pyproject models.

PoetryConfig

Bases: BaseModel

Poetry configuration model.

Source code in src/somesy/pyproject/models.py 
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 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
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
class PoetryConfig(BaseModel):
    """Poetry configuration model."""

    model_config = dict(use_enum_values=True)

    name: Annotated[
        str,
        Field(pattern=r"^[A-Za-z0-9]+([_-][A-Za-z0-9]+)*$", description="Package name"),
    ]
    version: Annotated[
        str,
        Field(
            pattern=r"^\d+(\.\d+)*((a|b|rc)\d+)?(post\d+)?(dev\d+)?$",
            description="Package version",
        ),
    ]
    description: Annotated[str, Field(description="Package description")]
    license: Annotated[
        Optional[Union[LicenseEnum, List[LicenseEnum]]],
        Field(description="An SPDX license identifier."),
    ]
    authors: Annotated[Set[str], Field(description="Package authors")]
    maintainers: Annotated[
        Optional[Set[str]], Field(description="Package maintainers")
    ] = None
    readme: Annotated[
        Optional[Union[Path, List[Path]]], Field(description="Package readme file(s)")
    ] = None
    homepage: Annotated[Optional[HttpUrlStr], Field(description="Package homepage")] = (
        None
    )
    repository: Annotated[
        Optional[HttpUrlStr], Field(description="Package repository")
    ] = None
    documentation: Annotated[
        Optional[HttpUrlStr], Field(description="Package documentation page")
    ] = None
    keywords: Annotated[
        Optional[Set[str]], Field(description="Keywords that describe the package")
    ] = None
    classifiers: Annotated[
        Optional[List[str]], Field(description="pypi classifiers")
    ] = None
    urls: Annotated[
        Optional[Dict[str, HttpUrlStr]], Field(description="Package URLs")
    ] = None

    @field_validator("version")
    @classmethod
    def validate_version(cls, v):
        """Validate version using PEP 440."""
        try:
            _ = parse_version(v)
        except ValueError as err:
            raise ValueError("Invalid version") from err
        return v

    @field_validator("authors", "maintainers")
    @classmethod
    def validate_email_format(cls, v):
        """Validate person format, omit person that is not in correct format, don't raise an error."""
        if v is None:
            return []
        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])
                ):
                    validated.append(author)
                else:
                    logger.warning(
                        f"Invalid email format for author/maintainer {author}, omitting."
                    )
            except ValidationError:
                logger.warning(
                    f"Invalid email format for author/maintainer {author}, omitting."
                )
        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")

validate_version classmethod 

validate_version(v)

Validate version using PEP 440.

Source code in src/somesy/pyproject/models.py 
74
75
76
77
78
79
80
81
82
@field_validator("version")
@classmethod
def validate_version(cls, v):
    """Validate version using PEP 440."""
    try:
        _ = parse_version(v)
    except ValueError as err:
        raise ValueError("Invalid version") from err
    return v

validate_email_format classmethod 

validate_email_format(v)

Validate person format, omit person that is not in correct format, don't raise an error.

Source code in src/somesy/pyproject/models.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@field_validator("authors", "maintainers")
@classmethod
def validate_email_format(cls, v):
    """Validate person format, omit person that is not in correct format, don't raise an error."""
    if v is None:
        return []
    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])
            ):
                validated.append(author)
            else:
                logger.warning(
                    f"Invalid email format for author/maintainer {author}, omitting."
                )
        except ValidationError:
            logger.warning(
                f"Invalid email format for author/maintainer {author}, omitting."
            )
    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 
109
110
111
112
113
114
115
116
117
118
@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")

ContentTypeEnum

Bases: Enum

Content type enum for setuptools field file.

Source code in src/somesy/pyproject/models.py 
121
122
123
124
125
126
class ContentTypeEnum(Enum):
    """Content type enum for setuptools field file."""

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

File

Bases: BaseModel

File model for setuptools.

Source code in src/somesy/pyproject/models.py 
129
130
131
132
133
class File(BaseModel):
    """File model for setuptools."""

    file: Path
    content_type: Optional[ContentTypeEnum] = Field(alias="content-type")

License

Bases: BaseModel

License model for setuptools.

Source code in src/somesy/pyproject/models.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
class License(BaseModel):
    """License model for setuptools."""

    model_config = dict(validate_assignment=True)

    file: Optional[Path] = None
    text: Optional[LicenseEnum] = None

    @model_validator(mode="before")
    @classmethod
    def validate_xor(cls, values):
        """Validate that only one of file or text is set."""
        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 
144
145
146
147
148
149
150
@model_validator(mode="before")
@classmethod
def validate_xor(cls, values):
    """Validate that only one of file or text is set."""
    if sum([bool(v) for v in values.values()]) != 1:
        raise ValueError("Either file or text must be set.")
    return values

STPerson

Bases: BaseModel

Person model for setuptools.

Source code in src/somesy/pyproject/models.py 
153
154
155
156
157
class STPerson(BaseModel):
    """Person model for setuptools."""

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

URLs

Bases: BaseModel

URLs model for setuptools.

Source code in src/somesy/pyproject/models.py 
160
161
162
163
164
165
166
class URLs(BaseModel):
    """URLs model for setuptools."""

    homepage: Optional[HttpUrlStr] = None
    repository: Optional[HttpUrlStr] = None
    documentation: Optional[HttpUrlStr] = None
    changelog: Optional[HttpUrlStr] = None

SetuptoolsConfig

Bases: BaseModel

Setuptools input model. Required fields are name, version, description, and requires_python.

Source code in src/somesy/pyproject/models.py 
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class SetuptoolsConfig(BaseModel):
    """Setuptools input model. Required fields are name, version, description, and requires_python."""

    model_config = dict(use_enum_values=True)

    name: Annotated[str, Field(pattern=r"^[A-Za-z0-9]+([_-][A-Za-z0-9]+)*$")]
    version: Annotated[
        str, Field(pattern=r"^\d+(\.\d+)*((a|b|rc)\d+)?(post\d+)?(dev\d+)?$")
    ]
    description: str
    readme: Optional[Union[Path, List[Path], File]] = None
    license: Optional[License] = Field(None, description="An SPDX license identifier.")
    authors: Optional[List[STPerson]] = None
    maintainers: Optional[List[STPerson]] = None
    keywords: Optional[Set[str]] = None
    classifiers: Optional[List[str]] = None
    urls: Optional[URLs] = None

    @field_validator("version")
    @classmethod
    def validate_version(cls, v):
        """Validate version using PEP 440."""
        try:
            _ = parse_version(v)
        except ValueError as err:
            raise ValueError("Invalid version") from err
        return 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):
                raise ValueError("Some file(s) do not exist")
        elif type(v) is File:
            if not Path(v.file).is_file():
                raise ValueError("File does not exist")
        else:
            if not v.is_file():
                raise ValueError("File does not exist")

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

validate_version classmethod 

validate_version(v)

Validate version using PEP 440.

Source code in src/somesy/pyproject/models.py 
187
188
189
190
191
192
193
194
195
@field_validator("version")
@classmethod
def validate_version(cls, v):
    """Validate version using PEP 440."""
    try:
        _ = parse_version(v)
    except ValueError as err:
        raise ValueError("Invalid version") from err
    return v

validate_readme classmethod 

validate_readme(v)

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

Source code in src/somesy/pyproject/models.py 
197
198
199
200
201
202
203
204
205
206
207
208
209
@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):
            raise ValueError("Some file(s) do not exist")
    elif type(v) is File:
        if not Path(v.file).is_file():
            raise ValueError("File does not exist")
    else:
        if not v.is_file():
            raise ValueError("File does not exist")

validate_email_format classmethod 

validate_email_format(v)

Validate email format.

Source code in src/somesy/pyproject/models.py 
211
212
213
214
215
216
217
218
219
@field_validator("authors", "maintainers")
@classmethod
def validate_email_format(cls, v):
    """Validate email format."""
    for person in v:
        if person.email:
            if not EMailAddress.validate_python(person.email):
                raise ValueError("Invalid email format")
    return v