Pkg infra docs
Description¶
The top-level pkg_infra package exposes the main public entrypoint used by
downstream projects. In practice, this means importing get_session(...)
without forcing callers to know the internal module layout.
Main Components¶
get_session: Initialize or retrieve the process-wide session__version__: Package version metadata__author__: Package author metadata
pkg_infra
¶
Session handler, configuration, and logging handler for Saezlab packages and applications.
get_session(workspace, include_location=False, config_path=None)
¶
Lazily import and return pkg_infra.session.get_session.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
workspace
|
str | Path
|
Path to the workspace directory. |
required |
include_location
|
bool
|
Whether to allow lazy geolocation lookup. |
False
|
config_path
|
str | Path | None
|
Optional path to a custom configuration file to merge. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
Session |
object
|
The current session instance. |
log_files()
¶
Return every active log-file path.
Thin re-export of :func:pkg_infra.logger.log_files.
logfile()
¶
Return the current active log file, or None if none is configured.
Thin re-export of :func:pkg_infra.logger.logfile.
open_log(path=None, pager=None)
¶
Open a log file in a terminal pager.
Thin re-export of :func:pkg_infra.logger.open_log.