nitpick.style module

Style parsing and merging.

class nitpick.style.BuiltinStyle(*, formatted: str, path_from_resources_root: str)

Bases: object

A built-in style file in TOML format.

Method generated by attrs for class BuiltinStyle.

files: list[str]

formatted: str

classmethod from_path(resource_path: Path, library_dir: Path | None = None) → BuiltinStyle

Create a style from its path.

identify_tag: str

name: str

path_from_resources_root: str

url: str

class nitpick.style.ConfigValidator(project: Project)

Bases: object

Validate a nitpick configuration.

project: Project

validate(config_dict: dict) → tuple[dict, dict]

Validate an already parsed toml file.

class nitpick.style.FileFetcher(session: ~requests_cache.session.CachedSession | None = None, protocols: tuple[str, ...] = (<Scheme.FILE: 'file'>, ), domains: tuple[str, ...] = ())

Bases: StyleFetcher

Fetch a style from a local file.

domains: tuple[str, ...] = ()

fetch(url: furl) → str

Fetch a style from a local file.

normalize(url: furl) → furl

Normalize a URL.

Produces a canonical URL, meant to be used to uniquely identify a style resource.

• The base name has .toml appended if not already ending in that extension

• Individual fetchers can further normalize the path and scheme.

preprocess_relative_url(url: str) → str

Preprocess a relative URL.

Only called for urls that lack a scheme (at the very least), being resolved against a base URL that matches this specific fetcher.

Relative paths are file paths; any ~ home reference is expanded at this point.

protocols: tuple[str, ...] = (<Scheme.FILE: 'file'>,)

requires_connection: ClassVar[bool] = False

session: CachedSession | None = None

class nitpick.style.GitHubFetcher(session: ~requests_cache.session.CachedSession | None = None, protocols: tuple[str, ...] = (<Scheme.GH: 'gh'>, <Scheme.GITHUB: 'github'>), domains: tuple[str, ...] = ('github.com', ))

Bases: HttpFetcher

Fetch styles from GitHub repositories.

domains: tuple[str, ...] = ('github.com',)

fetch(url: furl) → str

Fetch the style from a web location.

normalize(url: furl) → furl

Normalize a URL.

Produces a canonical URL, meant to be used to uniquely identify a style resource.

• The base name has .toml appended if not already ending in that extension

• Individual fetchers can further normalize the path and scheme.

preprocess_relative_url(url: str) → str

Preprocess a relative URL.

Only called for urls that lack a scheme (at the very least), being resolved against a base URL that matches this specific fetcher.

protocols: tuple[str, ...] = (<Scheme.GH: 'gh'>, <Scheme.GITHUB: 'github'>)

requires_connection: ClassVar[bool] = True

session: CachedSession | None = None

class nitpick.style.GitHubURL(owner: str, repository: str, git_reference: str, path: tuple[str, ...] = (), auth_token: str | None = None, query_params: tuple[tuple[str, str], ...] | None = None)

Bases: object

Represent a GitHub URL, created from a URL or from its parts.

property api_url: furl

API URL for this repo.

auth_token: str | None = None

property authorization_header: dict[str, str] | None

Authorization header encoded in this URL.

property default_branch: str

Default GitHub branch.

classmethod from_furl(url: furl) → GitHubURL

Create an instance from a parsed URL in any accepted format.

See the code for test_parsing_github_urls() for more examples.

git_reference: str

property git_reference_or_default: str

Return the Git reference if informed, or return the default branch.

property long_protocol_url: furl

Long protocol URL (github).

owner: str

path: tuple[str, ...] = ()

query_params: tuple[tuple[str, str], ...] | None = None

property raw_content_url: furl

Raw content URL for this path.

repository: str

property short_protocol_url: furl

Short protocol URL (gh).

property token: str | None

Token encoded in this URL.

If present and it starts with a $, it will be replaced with the value of the environment corresponding to the remaining part of the string.

property url: furl

Default URL built from attributes.

class nitpick.style.HttpFetcher(session: ~requests_cache.session.CachedSession | None = None, protocols: tuple[str, ...] = (<Scheme.HTTP: 'http'>, <Scheme.HTTPS: 'https'>), domains: tuple[str, ...] = ())

Bases: StyleFetcher

Fetch a style from an http/https server.

domains: tuple[str, ...] = ()

fetch(url: furl) → str

Fetch the style from a web location.

normalize(url: furl) → furl

Normalize a URL.

Produces a canonical URL, meant to be used to uniquely identify a style resource.

• The base name has .toml appended if not already ending in that extension

• Individual fetchers can further normalize the path and scheme.

preprocess_relative_url(url: str) → str

Preprocess a relative URL.

Only called for urls that lack a scheme (at the very least), being resolved against a base URL that matches this specific fetcher.

protocols: tuple[str, ...] = (<Scheme.HTTP: 'http'>, <Scheme.HTTPS: 'https'>)

requires_connection: ClassVar[bool] = True

session: CachedSession | None = None

class nitpick.style.PythonPackageFetcher(session: ~requests_cache.session.CachedSession | None = None, protocols: tuple[str, ...] = (<Scheme.PY: 'py'>, <Scheme.PYPACKAGE: 'pypackage'>), domains: tuple[str, ...] = ())

Bases: StyleFetcher

Fetch a style from an installed Python package.

URL schemes: - py://import/path/of/style/file/<style_file_name> - pypackage://import/path/of/style/file/<style_file_name>

E.g. py://some_package/path/nitpick.toml.

domains: tuple[str, ...] = ()

fetch(url: furl) → str

Fetch the style from a Python package.

normalize(url: furl) → furl

Normalize a URL.

Produces a canonical URL, meant to be used to uniquely identify a style resource.

• The base name has .toml appended if not already ending in that extension

• Individual fetchers can further normalize the path and scheme.

preprocess_relative_url(url: str) → str

Preprocess a relative URL.

Only called for urls that lack a scheme (at the very least), being resolved against a base URL that matches this specific fetcher.

protocols: tuple[str, ...] = (<Scheme.PY: 'py'>, <Scheme.PYPACKAGE: 'pypackage'>)

requires_connection: ClassVar[bool] = False

session: CachedSession | None = None

class nitpick.style.PythonPackageURL(import_path: str, resource_name: str)

Bases: object

Represent a resource file in installed Python package.

property content_path: Path

Raw path of resource file.

classmethod from_furl(url: furl) → PythonPackageURL

Create an instance from a parsed URL in any accepted format.

See the code for test_parsing_python_package_urls() for more examples.

import_path: str

resource_name: str

class nitpick.style.Scheme(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: LowercaseStrEnum

URL schemes.

FILE = 'file'

GH = 'gh'

GITHUB = 'github'

HTTP = 'http'

HTTPS = 'https'

PY = 'py'

PYPACKAGE = 'pypackage'

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count

Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep

The separator used to split the string.

When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.

maxsplit

Maximum number of splits (starting from the left). -1 (the default value) means no limit.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate(table, /)

Replace each character in the string using the given translation table.

table

Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class nitpick.style.StyleFetcher(session: CachedSession | None = None, protocols: tuple[str, ...] = (), domains: tuple[str, ...] = ())

Bases: object

Base class of all fetchers, it encapsulates get/fetch from a specific source.

domains: tuple[str, ...] = ()

fetch(url: furl) → str

Fetch a style from a specific fetcher.

normalize(url: furl) → furl

Normalize a URL.

Produces a canonical URL, meant to be used to uniquely identify a style resource.

• The base name has .toml appended if not already ending in that extension

• Individual fetchers can further normalize the path and scheme.

preprocess_relative_url(url: str) → str

Preprocess a relative URL.

Only called for urls that lack a scheme (at the very least), being resolved against a base URL that matches this specific fetcher.

protocols: tuple[str, ...] = ()

requires_connection: ClassVar[bool] = False

session: CachedSession | None = None

class nitpick.style.StyleFetcherManager(offline: bool, cache_dir: Path, cache_option: str)

Bases: object

Manager that controls which fetcher to be used given a protocol.

cache_dir: Path

cache_option: str

fetch(url: furl) → str | None

Determine which fetcher to be used and fetch from it.

Returns None when offline is True and the fetcher would otherwise require a connection.

fetchers: dict[str, nitpick.style.StyleFetcher]

normalize_url(url: str | furl, base: furl) → furl

Normalize a style URL.

The URL is made absolute against base, then passed to individual fetchers to produce a canonical version of the URL.

offline: bool

schemes: tuple[str]

session: CachedSession

class nitpick.style.StyleManager(project: Project, offline: bool, cache_option: str)

Bases: object

Include styles recursively from one another.

property cache_dir: Path

Clear the cache directory (on the project root or on the current directory).

cache_option: str

static file_field_pair(filename: str, base_file_class: type[NitpickPlugin]) → dict[str, fields.Field]

Return a schema field with info from a config file class.

find_initial_styles(configured_styles: Sequence[str], base: str | None = None) → Iterator[Fuss]

Find the initial style(s) and include them.

base is the URL for the source of the initial styles, and is used to resolve relative references. If omitted, defaults to the project root.

static get_default_style_url(github=False) → furl

Return the URL of the default style/preset.

include_multiple_styles(chosen_styles: Iterable[furl]) → Iterator[Fuss]

Include a list of styles (or just one) into this style tree.

load_fixed_name_plugins() → set[type[NitpickPlugin]]

Separate classes with fixed file names from classes with dynamic files names.

merge_toml_dict() → JsonDict

Merge all included styles into a TOML (actually JSON) dictionary.

offline: bool

project: Project

rebuild_dynamic_schema() → None

Rebuild the dynamic Marshmallow schema when needed, adding new fields that were found on the style.

nitpick.style.builtin_resources_root() → Path

Built-in resources root.

nitpick.style.builtin_styles() → Iterable[Path]

List the built-in styles.

nitpick.style.github_default_branch(api_url: str, *, token: str | None = None) → str

Get the default branch from the GitHub repo using the API.

For now, for URLs without an authorization token embedded, the request is not authenticated on GitHub, so it might hit a rate limit with: requests.exceptions.HTTPError: 403 Client Error: rate limit exceeded for url

This function is using lru_cache() as a simple memoizer, trying to avoid this rate limit error.

nitpick.style.parse_cache_option(cache_option: str) → tuple[nitpick.constants.CachingEnum, datetime.timedelta | int]

Parse the cache option provided on pyproject.toml.

If no cache is provided or is invalid, the default is one hour.

nitpick.style.repo_root() → Path

Repository root, 3 levels up from the resources root.