rlsbl v0.92.0 /rlsbl.targets.pypi
Updated
On this page

PyPI release target managing version tracking in pyproject.toml, OIDC-based CI scaffolding, asset builds, dep rewriting, and dev-install.

#rlsbl.targets.pypi

#rlsbl.targets.pypi

PyPI release target that manages version tracking in pyproject.toml and scaffolds CI workflows for OIDC-based publishing to the PyPI index.

#find_dunder_version_node

python
def find_dunder_version_node(content: str) -> 'ast.Constant | None'

Find an __version__ assignment with a static string literal via AST.

Handles both plain assignments (__version__ = "1.0.0") and typed annotations (__version__: str = "1.0.0"). Returns the ast.Constant node for the string value, or None if not found or the file has a syntax error.

#has_any_dunder_version

python
def has_any_dunder_version(content: str) -> bool

Check whether the source contains any form of __version__ definition.

Returns True if the content contains any assignment, annotated assignment, or import of __version__ -- regardless of whether the value is a static literal. Returns False on SyntaxError or if no __version__ definition is found.

#PypiTarget

Release target for Python projects (pyproject.toml).

#name

python
def name(self)

#detect

python
def detect(self, dir_path)

#read_name

python
def read_name(self, dir_path, ctx)

Read the project name from pyproject.toml.

#read_metadata

python
def read_metadata(self, dir_path)

Read license and description from pyproject.toml.

#format_version

python
def format_version(self, version)

Translate semver pre-release to PEP 440 format.

  • 1.2.3-alpha.0 -> 1.2.3a0
  • 1.2.3-beta.1 -> 1.2.3b1
  • 1.2.3-rc.2 -> 1.2.3rc2
  • Stable versions pass through unchanged.

#_pep440_to_semver

python
def _pep440_to_semver(version)

Translate PEP 440 pre-release back to semver format.

  • 1.2.3a0 -> 1.2.3-alpha.0
  • 1.2.3b1 -> 1.2.3-beta.1
  • 1.2.3rc2 -> 1.2.3-rc.2
  • Stable versions pass through unchanged.

#read_version

python
def read_version(self, dir_path)

Read the version from pyproject.toml in the given directory.

If the version is in PEP 440 pre-release format (e.g. 1.2.3a0), it is converted back to semver format (1.2.3-alpha.0) so that all internal version handling uses a consistent semver representation.

#write_version

python
def write_version(self, dir_path, version, ctx)

Write a new version to pyproject.toml and __version__ in package source.

Translates semver pre-release versions to PEP 440 format before writing (e.g. 1.2.3-alpha.0 -> 1.2.3a0).

Returns a list of relative file paths (relative to dir_path) that were modified.

#_update_dunder_version

python
def _update_dunder_version(self, dir_path, doc, version)

Update __version__ in the package's __init__.py if present.

Uses AST parsing to find __version__ assignments with static string literals, handling plain assignments and typed annotations.

Returns the relative path (relative to dir_path) of the file that was modified, or None if no file was updated.

#version_file

python
def version_file(self, dir_path=None)

#tag_format

python
def tag_format(self, version)

#template_dir

python
def template_dir(self)

#template_vars

python
def template_vars(self, dir_path, ctx)

Extract template variables from the target project's pyproject.toml.

#template_mappings

python
def template_mappings(self, ctx)

#build

python
def build(self, dir_path, version)

Build the package, rewriting path deps if in a monorepo context.

When the project has path dependencies (e.g., sibling packages in a monorepo), copies the project to a temp directory with rewritten pyproject.toml so the working tree is never modified. Otherwise runs uv build in place.

#_build_with_rewrite

python
def _build_with_rewrite(self, dir_path, pyproject_path, rewrite_map)

Copy project to a temp dir with rewritten deps, then build.

#check_project_exists

python
def check_project_exists(self, dir_path)

#get_project_init_hint

python
def get_project_init_hint(self)

#dev_install_command

python
def dev_install_command(self, project_dir)