Skip to content

Commit

Permalink
Remove whitespace, fix type hints, add __all__ export list
Browse files Browse the repository at this point in the history
  • Loading branch information
CPBridge committed Jan 11, 2024
1 parent 3a5ac29 commit 271d806
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ classifiers = [
]

[tool.poetry.dependencies]
python = ">=3.7"
python = ">=3.6"
GitPython = ">=3.0.0"

[tool.poetry.group.dev.dependencies]
Expand Down
10 changes: 10 additions & 0 deletions src/pycrumbs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,13 @@
tracked,
write_record,
) # noqa: F401


__all__ = [
"get_environment_info",
"get_git_info",
"get_installed_packages",
"seed_tasks",
"tracked",
"write_record",
]
8 changes: 4 additions & 4 deletions src/pycrumbs/track.py
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ def tracked(
record_filename: Optional[str] = None,
extra_modules: Optional[Sequence[Union[str, ModuleType]]] = None,
extra_environment_variables: Optional[Sequence[str]] = None,
seed_parameter: str = None,
seed_parameter: str | None = None,
disable_git_tracking: bool = False,
allow_dirty_repo: bool = True,
include_package_inventory: bool = True,
Expand Down Expand Up @@ -394,7 +394,7 @@ def tracked(
that exists within a git repository.
extra_environment_variables: Optional[Sequence[str]]
Names of extra environment variables to include in the job record.
seed_parameter: str
seed_parameter: Optional[str]
Name of the parameter of the decorated function to use as a random
seed. If this parameter is given an integer value at runtime, that
value will be used to set the random seed for several key libraries
Expand Down Expand Up @@ -452,7 +452,7 @@ def tracked(
output directory. It may be used in other situations for convenience.
chain_records: bool
If True, a pre-existing record file will have a new record appended to
it within the same file. If False, a pre-existing record file will be
it within the same file. If False, a pre-existing record file will be
overwritten.
Examples
Expand Down Expand Up @@ -886,7 +886,7 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:

else:
out_record = record

write_record(full_record_path, record=out_record)

return result
Expand Down

0 comments on commit 271d806

Please sign in to comment.