Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow usage of environment variables in rules path #608

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions qgis_deployment_toolbelt/profiles/rules_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
# Standard library
import json
import logging
import os
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer complete function import rather than package. See other projects modules where we work with env vars to make it consistent with.

import platform
from datetime import date
from getpass import getuser
Expand Down Expand Up @@ -43,6 +44,13 @@


class QdtRulesContext:
def __init__(
self,
only_prefixed_variables: bool = True,
variables_prefix: list[str] = ["QDT_", "QGIS_"],
) -> None:
self.only_prefixed_variables = only_prefixed_variables
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docstring is missing

self.variables_prefix = variables_prefix

@property
def _context_date(self) -> dict:
Expand All @@ -60,6 +68,29 @@ def _context_date(self) -> dict:
"current_year": today.year,
}

@property
def _context_env(self) -> dict:
"""Returns a dictionary containing environment variables that can be used in
QDT various places: rules...

The environment variables can be filtered based on self.only_prefixed_variables
and self.variables_prefix settings.

Returns:
dict: dict with environment variables to use in rules.
"""
env_vars = dict(os.environ)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's already a mapping object no?

https://docs.python.org/3/library/os.html#os.environ


if self.only_prefixed_variables:
# Filter variables that start with any of the prefixes
return {
key: value
for key, value in env_vars.items()
if any(key.startswith(prefix) for prefix in self.variables_prefix)
}

return env_vars

@property
def _context_environment(self) -> dict:
"""Returns a dictionary containing some environment information (computer, network,
Expand Down
2 changes: 1 addition & 1 deletion qgis_deployment_toolbelt/utils/str2bool.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def str2bool(input_var: bool | str, raise_exc: bool = False) -> bool | None:

Args:
input_var (str): value to convert
raise_exc (bool, optional): strict mode, defaults to False. Defaults to False.
raise_exc (bool, optional): strict mode, defaults to False.

Raises:
ValueError: input_var is not in true and false sets
Expand Down
Loading