Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/reference/config-reference.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Configuration Reference
=======================

.. currentmodule:: fromager.packagesettings

Per-package Settings
--------------------

Expand All @@ -24,6 +26,43 @@ For example `flash_attn.yaml`.

.. autopydantic_model:: fromager.packagesettings.SbomSettings

Source Resolver
^^^^^^^^^^^^^^^

.. autopydantic_model:: PyPISDistResolver
:inherited-members: AbstractPyPIResolver, CooldownMixin

.. autopydantic_model:: PyPIPrebuiltResolver
:inherited-members: AbstractPyPIResolver, CooldownMixin

.. autopydantic_model:: PyPIDownloadResolver
:inherited-members: AbstractPyPIResolver, CooldownMixin

.. autopydantic_model:: PyPIGitResolver
:inherited-members: AbstractPyPIResolver, CooldownMixin

.. autopydantic_model:: GitHubTagDownloadResolver
:inherited-members: AbstractGitSourceResolver, CooldownMixin

.. autopydantic_model:: GitHubTagCloneResolver
:inherited-members: AbstractGitSourceResolver, CooldownMixin

.. autopydantic_model:: GitLabTagDownloadResolver
:inherited-members: AbstractGitSourceResolver, CooldownMixin

.. autopydantic_model:: GitLabTagCloneResolver
:inherited-members: AbstractGitSourceResolver, CooldownMixin

.. autopydantic_model:: NotAvailableResolver

.. autopydantic_model:: HookResolver

.. autoclass:: BuildSDist

.. autoattribute:: pep517
.. autoattribute:: tarball


Global Settings
---------------

Expand Down
26 changes: 26 additions & 0 deletions src/fromager/packagesettings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@
VariantInfo,
)
from ._pbi import PackageBuildInfo
from ._resolver import (
BuildSDist,
GitHubTagCloneResolver,
GitHubTagDownloadResolver,
GitLabTagCloneResolver,
GitLabTagDownloadResolver,
HookResolver,
NotAvailableResolver,
PyPIDownloadResolver,
PyPIGitResolver,
PyPIPrebuiltResolver,
PyPISDistResolver,
pep440_tag_matcher,
)
from ._settings import Settings, SettingsFile
from ._templates import substitute_template
from ._typedefs import (
Expand All @@ -36,18 +50,29 @@
"Annotations",
"BuildDirectory",
"BuildOptions",
"BuildSDist",
"DownloadSource",
"EnvKey",
"EnvVars",
"GitHubTagCloneResolver",
"GitHubTagDownloadResolver",
"GitLabTagCloneResolver",
"GitLabTagDownloadResolver",
"GitOptions",
"GlobalChangelog",
"HookResolver",
"NotAvailableResolver",
"Package",
"PackageBuildInfo",
"PackageSettings",
"PackageVersion",
"PatchMap",
"ProjectOverride",
"PurlConfig",
"PyPIDownloadResolver",
"PyPIGitResolver",
"PyPIPrebuiltResolver",
"PyPISDistResolver",
"RawAnnotations",
"ResolverDist",
"SbomSettings",
Expand All @@ -59,5 +84,6 @@
"VariantInfo",
"default_update_extra_environ",
"get_extra_environ",
"pep440_tag_matcher",
"substitute_template",
)
11 changes: 10 additions & 1 deletion src/fromager/packagesettings/_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from pydantic import AnyUrl, Field
from pydantic_core import core_schema

# from ._resolver import SourceResolver
from ._typedefs import (
MODEL_CONFIG,
BuildDirectory,
Expand Down Expand Up @@ -302,7 +303,7 @@ class VariantInfo(pydantic.BaseModel):
VAR1: "value 1"
VAR2: "2.0
wheel_server_url: https://pypi.org/simple/
pre_build: False
pre_built: False
"""

model_config = MODEL_CONFIG
Expand All @@ -323,6 +324,10 @@ class VariantInfo(pydantic.BaseModel):
pre_built: bool = False
"""Use pre-built wheel from index server?"""

# TODO
# source: SourceResolver | None
# """Source resolver and downloader"""


class GitOptions(pydantic.BaseModel):
"""Git repository cloning options
Expand Down Expand Up @@ -447,6 +452,10 @@ class PackageSettings(pydantic.BaseModel):
project_override: ProjectOverride = Field(default_factory=ProjectOverride)
"""Patch project settings"""

# TODO
# source: SourceResolver | None
# """Source resolver and downloader"""

variants: Mapping[Variant, VariantInfo] = Field(default_factory=dict)
"""Variant configuration"""

Expand Down
Loading
Loading