Production Utils
get_production_path(path: Optional[str] = None) -> Optional[str]
get_production_path(path: Optional[str] = None) -> Optional[str]
Constructs the absolute path to a resource file, adjusting based on the execution environment.
Parameters
path
(Optional[str]
, optional): The relative path to the resource file from the application's root directory. Defaults toNone
.
Return Value
Optional[str]
:If in production: The absolute path to the resource file (or the base path if
path
isNone
).If not in production: The original
path
value passed to the function.
Description
In a production environment (e.g., when packaged with PyInstaller or Nuitka), it prepends the application's base directory to the provided relative path. If no path is provided, it returns the base path itself. In a development environment (regular Python script), it simply returns the provided path as is. If no path is provided and not in production, it returns None
.
Example Usage
is_production() -> bool
is_production() -> bool
Checks if the current environment is a production environment.
Parameters
None
Return Value
bool
: ReturnsTrue
if it is a production environment, otherwise returnsFalse
.
Description
This function checks if the current execution environment is a production environment (e.g., PyInstaller or Nuitka bundle) by examining if the application is running as a bundled executable.
Example Usage
get_platform() -> str
get_platform() -> str
Returns the name of the current system's platform.
Parameters
None
Return Value
str
: Returns one of:"windows"
,"macos"
,"linux"
.
Description
Uses platform.system()
to determine the operating system and returns a standardized lowercase string representing the platform.
Example Usage
get_absolute_path(path: str) -> str
get_absolute_path(path: str) -> str
Returns the absolute path of the given relative path.
Parameters
path
(str
): The relative path to convert.
Return Value
str
: The absolute path.
Description
Converts a relative path to an absolute path, which is useful for accessing files regardless of the current working directory.
Example Usage
get_free_port() -> int
get_free_port() -> int
Finds and returns an available random network port number from the operating system.
Parameters
None
Return Value
int
: An available network port number (typically in the range 1024-65535).
Description
Creates a socket, binds to port 0
(let OS choose), retrieves the port, and closes the socket. Note that the port may be reassigned to another process after this function returns, so use it quickly.
Example Usage
Last updated
Was this helpful?