mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 04:55:44 +00:00
Compare commits
18 Commits
feature/re
...
feature/sk
| Author | SHA1 | Date | |
|---|---|---|---|
| 1af790f01a | |||
| 485ab9ef09 | |||
| 844a2f6f3f | |||
| 2092245dad | |||
| 16f753fdf3 | |||
| 9f1caf79ff | |||
| 70911f98b0 | |||
| 441a26127f | |||
| 9cc6f2483d | |||
| 6e24f9d70b | |||
| 8c18d01f05 | |||
| d7700c4863 | |||
| 948bc65e76 | |||
| a0627a0922 | |||
| 525107ad63 | |||
| d604179cbf | |||
| 31fe9b1afc | |||
| 78b86967e7 |
7
.coveragerc
Normal file
7
.coveragerc
Normal file
@@ -0,0 +1,7 @@
|
||||
[report]
|
||||
exclude_lines =
|
||||
# Have to re-enable the standard pragma
|
||||
pragma: no cover
|
||||
|
||||
# Don't complain if tests don't hit defensive assertion code:
|
||||
raise NotImplementedError
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -127,3 +127,6 @@ dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# custom
|
||||
.DS_Store
|
||||
|
||||
17
.vscode/settings.json
vendored
17
.vscode/settings.json
vendored
@@ -4,5 +4,20 @@
|
||||
"python.linting.enabled": true,
|
||||
"python.pythonPath": ".venv/bin/python",
|
||||
"restructuredtext.confPath": "${workspaceFolder}/docs/source",
|
||||
"peacock.color": "#307E6A"
|
||||
"peacock.color": "#307E6A",
|
||||
"workbench.colorCustomizations": {
|
||||
"editorGroup.border": "#3ea389",
|
||||
"panel.border": "#3ea389",
|
||||
"sash.hoverBorder": "#3ea389",
|
||||
"sideBar.border": "#3ea389",
|
||||
"statusBar.background": "#307e6a",
|
||||
"statusBar.foreground": "#e7e7e7",
|
||||
"statusBarItem.hoverBackground": "#3ea389",
|
||||
"statusBarItem.remoteBackground": "#307e6a",
|
||||
"statusBarItem.remoteForeground": "#e7e7e7",
|
||||
"titleBar.activeBackground": "#307e6a",
|
||||
"titleBar.activeForeground": "#e7e7e7",
|
||||
"titleBar.inactiveBackground": "#307e6a99",
|
||||
"titleBar.inactiveForeground": "#e7e7e799"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
# Author
|
||||
|
||||
Daniel Tomlinson (dtomlinson@panaetius.co.uk)
|
||||
|
||||
# Requires
|
||||
|
||||
`>= python3.7`
|
||||
|
||||
# Python requirements
|
||||
|
||||
- toml = "^0.10.0"
|
||||
- pylite = "^0.1.0"
|
||||
|
||||
# Documentation
|
||||
|
||||
_soon_
|
||||
|
||||
# Installation
|
||||
|
||||
_soon_
|
||||
|
||||
# Easy Way
|
||||
|
||||
## Python
|
||||
|
||||
### From pip
|
||||
|
||||
### From local wheel
|
||||
|
||||
### From source
|
||||
|
||||
# Example Usage
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
from panaetius.config_inst import CONFIG
|
||||
from .config import Config
|
||||
from .library import set_config
|
||||
from panaetius.header import __header__
|
||||
import panaetius.logging
|
||||
from panaetius.logging import logger as logger
|
||||
@@ -1 +0,0 @@
|
||||
__version__ = '1.0.2'
|
||||
@@ -1,178 +0,0 @@
|
||||
from typing import Callable, Union
|
||||
import os
|
||||
import toml
|
||||
|
||||
from panaetius.library import export
|
||||
from panaetius.header import __header__
|
||||
from panaetius.db import Mask
|
||||
|
||||
# __all__ = ['Config']
|
||||
|
||||
|
||||
class Config:
|
||||
|
||||
"""Handles the config options for the module and stores config variables
|
||||
to be shared.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
config_file : dict
|
||||
Contains the config options. See
|
||||
:meth:`~panaetius.config.Config.read_config`
|
||||
for the data structure.
|
||||
deferred_messages : list
|
||||
A list containing the messages to be logged once the logger has been
|
||||
instantiated.
|
||||
Mask : panaetius.db.Mask
|
||||
Class to mask values in a config file.
|
||||
module_name : str
|
||||
A string representing the module name. This is added in front of all
|
||||
envrionment variables and is the title of the `config.toml`.
|
||||
path : str
|
||||
Path to config file
|
||||
|
||||
Parameters
|
||||
----------
|
||||
path : str
|
||||
Path to config file
|
||||
"""
|
||||
|
||||
def __init__(self, path: str, header: str = __header__) -> None:
|
||||
"""
|
||||
See :class:`~panaetius.config.Config` for parameters.
|
||||
"""
|
||||
self.path = os.path.expanduser(path)
|
||||
self.header = header
|
||||
self.deferred_messages = []
|
||||
self.config_file = self.read_config(path)
|
||||
self.module_name = self.header.lower()
|
||||
self.Mask = Mask
|
||||
|
||||
def read_config(self, path: str, write: bool = False) -> Union[dict, None]:
|
||||
"""Reads the toml config file from `path` if it exists.
|
||||
|
||||
"""
|
||||
|
||||
path += 'config.toml' if path[-1] == '/' else '/config.toml'
|
||||
path = os.path.expanduser(path)
|
||||
if not write:
|
||||
try:
|
||||
with open(path, 'r+') as config_file:
|
||||
config_file = toml.load(config_file)
|
||||
self.defer_log(f'Config file found at {path}')
|
||||
return config_file
|
||||
except FileNotFoundError:
|
||||
self.defer_log(f'Config file not found at {path}')
|
||||
else:
|
||||
try:
|
||||
with open(path, 'w+') as config_file:
|
||||
config_file = toml.load(config_file)
|
||||
self.defer_log(f'Config file found at {path}')
|
||||
return config_file
|
||||
except FileNotFoundError:
|
||||
self.defer_log(f'Config file not found at {path}')
|
||||
|
||||
def get(
|
||||
self,
|
||||
key: str,
|
||||
default: str = None,
|
||||
cast: Callable = None,
|
||||
mask: bool = False,
|
||||
) -> Union[str, None]:
|
||||
"""Retrives the config variable from either the `config.toml` or an
|
||||
environment variable. Will default to the default value if nothing
|
||||
is found
|
||||
|
||||
Parameters
|
||||
----------
|
||||
key : str
|
||||
Key to the configuration variable. Should be in the form
|
||||
`panaetius.variable` or `panaetius.header.variable`.
|
||||
When loaded, it will be accessable at
|
||||
`Config.panaetius_variable` or
|
||||
`Config.panaetius_header_variable`.
|
||||
default : str, optional
|
||||
The default value if nothing is found. Defaults to `None`.
|
||||
cast : Callable, optional
|
||||
The type of the variable. E.g `int` or `float`. Should reference
|
||||
the type object and not as string. Defaults to `None`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
Will return the config variable if found, or the default.
|
||||
"""
|
||||
env_key = f"{self.header.upper()}_{key.upper().replace('.', '_')}"
|
||||
|
||||
try:
|
||||
# look in the config.toml
|
||||
if len(key.split('.')) == 2:
|
||||
# look for subsections
|
||||
# print(mask)
|
||||
if mask:
|
||||
# print('mask', key)
|
||||
value = self.Mask(
|
||||
self.path, self.config_file, key
|
||||
).get_value()
|
||||
else:
|
||||
# print('no-mask')
|
||||
section, name = key.lower().split('.')
|
||||
value = self.config_file[self.module_name][section][name]
|
||||
self.defer_log(f'{env_key} found in config.toml')
|
||||
else:
|
||||
# print('valueerror')
|
||||
# look under top level module self.header
|
||||
# key = f'{self.module_name}.key'
|
||||
if mask:
|
||||
# key = f'{self.header}.{key}'
|
||||
# print(f'mask key={key}')
|
||||
value = self.Mask(
|
||||
self.path, self.config_file, key
|
||||
).get_value()
|
||||
else:
|
||||
name = key.lower()
|
||||
value = self.config_file[self.module_name][name]
|
||||
self.defer_log(f'{env_key} found in config.toml')
|
||||
# finally:
|
||||
try:
|
||||
# return if found in config.toml
|
||||
return cast(value) if cast else value
|
||||
except UnboundLocalError:
|
||||
# pass if nothing was found
|
||||
# print('unbound error')
|
||||
pass
|
||||
except KeyError:
|
||||
# print('key error')
|
||||
self.defer_log(f'{env_key} not found in config.toml')
|
||||
except TypeError:
|
||||
# print('type error')
|
||||
self.defer_log(f'{env_key} not found in config.toml')
|
||||
|
||||
# look for an environment variable
|
||||
value = os.environ.get(env_key.replace("-", "_"))
|
||||
|
||||
if value is not None:
|
||||
self.defer_log(f'{env_key} found in an environment variable')
|
||||
else:
|
||||
# fall back to default
|
||||
self.defer_log(f'{env_key} not found in an environment variable.')
|
||||
value = default
|
||||
self.defer_log(f'{env_key} set to default {default}')
|
||||
return cast(value) if cast else value
|
||||
|
||||
def defer_log(self, msg: str) -> None:
|
||||
"""Populates a list `Config.deferred_messages` with all the events to
|
||||
be passed to the logger later if required.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
msg : str
|
||||
The message to be logged.
|
||||
"""
|
||||
self.deferred_messages.append(msg)
|
||||
|
||||
def reset_log(self) -> None:
|
||||
"""Empties the list `Config.deferred_messages`.
|
||||
"""
|
||||
del self.deferred_messages
|
||||
self.deferred_messages = []
|
||||
@@ -1,9 +0,0 @@
|
||||
import os
|
||||
|
||||
from panaetius.header import __header__
|
||||
from panaetius.config import Config
|
||||
|
||||
|
||||
DEFAULT_CONFIG_PATH = f"~/.config/{__header__.lower()}"
|
||||
CONFIG_PATH = os.environ.get(f"{__header__.upper()}_CONFIG_PATH", DEFAULT_CONFIG_PATH)
|
||||
CONFIG = Config(CONFIG_PATH)
|
||||
@@ -1,256 +0,0 @@
|
||||
from os import path, urandom
|
||||
import hashlib
|
||||
from typing import Tuple
|
||||
import toml
|
||||
import io
|
||||
|
||||
from pylite.simplite import Pylite
|
||||
|
||||
from panaetius.header import __header__ as __header__
|
||||
import panaetius
|
||||
|
||||
|
||||
class Mask:
|
||||
|
||||
"""Class to handle masking sensitive values in a config file
|
||||
|
||||
Attributes
|
||||
----------
|
||||
config_contents : dict
|
||||
A dict containing the contents of the config file.
|
||||
config_path : str
|
||||
The path to the config file.
|
||||
config_var : str
|
||||
The key corresponding to the config entry.
|
||||
database : Pylite
|
||||
A Pylite instance for the datbase.
|
||||
entry : str
|
||||
The result from the config file. Could either be a hash or the raw
|
||||
value.
|
||||
header : str
|
||||
The __header__ which denotes where the config file is stored.
|
||||
name : str
|
||||
The key of the entry in the config file.
|
||||
result : str
|
||||
The value of the entry in the config file.
|
||||
table_name : str
|
||||
The sqlite table name. Defaults to the __header__ value.
|
||||
"""
|
||||
|
||||
@property
|
||||
def hash(self):
|
||||
"""Property to determine the hash of a config entry.
|
||||
|
||||
Returns
|
||||
-------
|
||||
bytes
|
||||
The hash as a bytes object.
|
||||
"""
|
||||
try:
|
||||
if not self._hash_exists:
|
||||
pass
|
||||
except AttributeError:
|
||||
self._hash = hashlib.pbkdf2_hmac(
|
||||
'sha256',
|
||||
self.entry[self.name].encode('utf-8'),
|
||||
self.salt,
|
||||
100000,
|
||||
dklen=12,
|
||||
)
|
||||
self._hash_exists = True
|
||||
finally:
|
||||
return self._hash
|
||||
|
||||
@property
|
||||
def salt(self):
|
||||
"""Property to detemine a random salt to use in creation of the hash.
|
||||
|
||||
Returns
|
||||
-------
|
||||
bytes
|
||||
The salt as a bytes object.
|
||||
"""
|
||||
self._salt = urandom(32)
|
||||
return self._salt
|
||||
|
||||
@staticmethod
|
||||
def as_string(obj: bytes) -> str:
|
||||
"""Static method to return a string from a bytes object.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obj : bytes
|
||||
Bytes object to be converted to a string.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
The bytes object as a string.
|
||||
"""
|
||||
return bytes.hex(obj)
|
||||
|
||||
@staticmethod
|
||||
def fromhex(obj: str) -> bytes:
|
||||
"""Static method to create a bytes object from a string.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
obj : str
|
||||
String object to be converted to bytes.
|
||||
|
||||
Returns
|
||||
-------
|
||||
bytes
|
||||
The string object as bytes.
|
||||
"""
|
||||
return bytes.fromhex(obj)
|
||||
|
||||
@staticmethod
|
||||
def _from_key(config_var) -> Tuple[str, str]:
|
||||
try:
|
||||
header, name = config_var.split('.')
|
||||
except ValueError:
|
||||
header = ''
|
||||
name = config_var
|
||||
return (header, name)
|
||||
|
||||
def __init__(
|
||||
self, config_path: str, config_contents: dict, config_var: str
|
||||
):
|
||||
"""Summary
|
||||
See :class:`~Mask` for parameters.
|
||||
"""
|
||||
self.table: str = __header__
|
||||
self.config_path = config_path
|
||||
self.config_contents = config_contents
|
||||
self.config_var = config_var.replace('.', '_')
|
||||
self.header = self._from_key(config_var)[0]
|
||||
self.name = self._from_key(config_var)[1]
|
||||
try:
|
||||
# If value is under a subsection
|
||||
self.entry = self.config_contents[self.table][self.header]
|
||||
except KeyError:
|
||||
# If value is under the main header
|
||||
self.entry = self.config_contents[self.table]
|
||||
|
||||
def _get_database_file(self):
|
||||
self.database = self.config_path
|
||||
self.database += (
|
||||
f'.{self.table}.db'
|
||||
if self.config_path[-1] == '/'
|
||||
else f'/.{self.table}.db'
|
||||
)
|
||||
self.database = path.expanduser(self.database)
|
||||
return self
|
||||
|
||||
def _open_database(self):
|
||||
self.database = Pylite(self.database)
|
||||
|
||||
def _get_table(self):
|
||||
tables = [i[0] for i in self.database.get_tables()]
|
||||
if self.table not in tables:
|
||||
# panaetius.logger.debug(
|
||||
# 'Table not present in the database;'
|
||||
# f'creating the table {self.table} now'
|
||||
# )
|
||||
self.database.add_table(
|
||||
f'{self.table}',
|
||||
Name='text',
|
||||
Hash='text',
|
||||
Salt='text',
|
||||
Value='text',
|
||||
)
|
||||
else:
|
||||
# panaetius.logger.debug('Table already exists in the database')
|
||||
pass
|
||||
self.table_name = self.table
|
||||
|
||||
def _check_entries(self):
|
||||
var = self.database.get_items(self.table, f'Name="{self.config_var}"')
|
||||
if len(var) == 0:
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
def _insert_entries(self):
|
||||
self.database.insert(
|
||||
self.table,
|
||||
self.config_var,
|
||||
self.as_string(self.hash),
|
||||
self.as_string(self.salt),
|
||||
self.entry[self.name],
|
||||
)
|
||||
|
||||
def _update_entries_in_db(self):
|
||||
self.database.remove(self.table, f'Name="{self.config_var}"')
|
||||
self._insert_entries()
|
||||
|
||||
def _run_query(self, query: str):
|
||||
cur = self.database.db.cursor()
|
||||
cur.execute(query)
|
||||
self.database.db.commit()
|
||||
self.result = cur.fetchall()
|
||||
return self
|
||||
|
||||
def _get_all_items(self, where_clause: str = None):
|
||||
if where_clause is not None:
|
||||
self.result = self.database.get_items(self.table, where_clause)
|
||||
else:
|
||||
self.result = self.database.get_items(self.table)
|
||||
return self
|
||||
|
||||
def _process(self):
|
||||
if not self._check_entries():
|
||||
# panaetius.logger.debug('does not exist')
|
||||
self._insert_entries()
|
||||
self._update_entries_in_config()
|
||||
self._get_all_items()
|
||||
# panaetius.logger.debug(f'returning: {self.result[0][3]}')
|
||||
return self.entry[self.name]
|
||||
else:
|
||||
self._get_all_items(f'Name="{self.config_var}"')
|
||||
if self.result[0][1] == self.entry[self.name]:
|
||||
# panaetius.logger.debug('exists and hash matches')
|
||||
# panaetius.logger.debug(f'returning: {self.result[0][3]}')
|
||||
return self.result
|
||||
else:
|
||||
# panaetius.logger.debug('exists and hash doesnt match')
|
||||
# panaetius.logger.debug(
|
||||
# f'file_hash={self.entry[self.name]}, {self.result[0][1]}'
|
||||
# )
|
||||
self._update_entries_in_db()
|
||||
self._update_entries_in_config()
|
||||
self._get_all_items(f'Name="{self.config_var}"')
|
||||
# panaetius.logger.debug(f'returning: {self.result[0][3]}')
|
||||
return self.entry[self.name]
|
||||
|
||||
def _open_config_file(self) -> io.TextIOWrapper:
|
||||
self.config_path += (
|
||||
'/config.toml' if self.config_path[-1] != '/' else 'config.toml'
|
||||
)
|
||||
c = open(path.expanduser(self.config_path), 'w')
|
||||
return c
|
||||
|
||||
def _update_entries_in_config(self):
|
||||
self.entry.update({self.name: self.as_string(self.hash)})
|
||||
# panaetius.logger.debug(self.config_contents)
|
||||
# panaetius.logger.debug(self.entry)
|
||||
c = self._open_config_file()
|
||||
toml.dump(self.config_contents, c)
|
||||
c.close()
|
||||
|
||||
def get_value(self):
|
||||
"""Get the true value from the database if it exists, create if it'
|
||||
' doesn't exist or update if the hash has changed.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
The result from the database.
|
||||
"""
|
||||
# print(f'key in db {self.config_var}')
|
||||
self._get_database_file()
|
||||
self._open_database()
|
||||
self._get_table()
|
||||
self._process()
|
||||
return self.result[0][3]
|
||||
@@ -1,26 +0,0 @@
|
||||
import os
|
||||
from importlib import util
|
||||
|
||||
__path = os.getcwd()
|
||||
|
||||
try:
|
||||
__spec = util.spec_from_file_location(
|
||||
'__header__', f'{os.getcwd()}/__header__.py'
|
||||
)
|
||||
__header__ = util.module_from_spec(__spec)
|
||||
__spec.loader.exec_module(__header__)
|
||||
__header__ = __header__.__header__
|
||||
except FileNotFoundError:
|
||||
try:
|
||||
venv = os.environ.get('VIRTUAL_ENV').split('/')[-1]
|
||||
__header__ = venv
|
||||
except AttributeError:
|
||||
print(
|
||||
f'Cannot find a __header__.py file in {os.getcwd()} containing the'
|
||||
' __header__ value of your project name and you are not working'
|
||||
' from a virtual environment. Either make sure this file '
|
||||
'exists and the value is set or create and work from a virtual '
|
||||
'environment and try again. \n The __header__ value has been '
|
||||
'set to the default of panaetius.'
|
||||
)
|
||||
__header__ = 'panaetius'
|
||||
@@ -1,112 +0,0 @@
|
||||
from __future__ import annotations
|
||||
import sys
|
||||
from typing import Any, TypeVar, Type, TYPE_CHECKING, Union, List
|
||||
import ast
|
||||
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import logging
|
||||
|
||||
|
||||
config_inst_t = TypeVar('config_inst_t', bound='panaetius.config.Config')
|
||||
|
||||
|
||||
def export(fn: callable) -> callable:
|
||||
mod = sys.modules[fn.__module__]
|
||||
if hasattr(mod, '__all__'):
|
||||
mod.__all__.append(fn.__name__)
|
||||
else:
|
||||
mod.__all__ = [fn.__name__]
|
||||
return fn
|
||||
|
||||
|
||||
def set_config(
|
||||
config_inst: Type[config_inst_t],
|
||||
key: str,
|
||||
default: str = None,
|
||||
cast: Any = None,
|
||||
check: Union[None, List] = None,
|
||||
mask: bool = False,
|
||||
) -> None:
|
||||
"""Sets the config variable on the instance of a class.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
config_inst : Type[config_inst_t]
|
||||
Instance of the :class:`~panaetius.config.Config` class.
|
||||
key : str
|
||||
The key referencing the config variable.
|
||||
default : str, optional
|
||||
The default value.
|
||||
mask : bool, optional
|
||||
Boolean to indiciate if a value in the `config.toml` should be masked.
|
||||
If this is set to True then the first time the variable is read from
|
||||
the config file the value will be replaced with a hash. Any time that
|
||||
value is then read the hash will be compared to the one stored and if
|
||||
they match the true value will be returned. This is stored in a sqlite
|
||||
`.db` next to the config file and is hidden by default. If the hash
|
||||
provided doesn't match the default behaviour is to update the `.db`
|
||||
with the new value and hash the value again. If you delete the
|
||||
database file then you will need to set the value again in the
|
||||
`config.toml`.
|
||||
cast : Any, optional
|
||||
The type of the variable.
|
||||
check : Union[None, List], optional
|
||||
Type of object to check against. This is useful if you want to use TOML
|
||||
to define a list, but want to make sure that a string representation
|
||||
of a list will be loaded properly if it set as an environment variable.
|
||||
|
||||
Example:
|
||||
|
||||
*config.toml* has the following attribute set::
|
||||
|
||||
[package.users]
|
||||
auth = ['user1', 'user2']
|
||||
|
||||
If set as an environment variable you can pass this list as a string
|
||||
and set :code:`check=list`::
|
||||
|
||||
Environment variable:
|
||||
PACKAGE_USERS_AUTH = "['user1', 'user2']"
|
||||
|
||||
Usage in code::
|
||||
|
||||
set_config(CONFIG, 'users.auth', check=list)
|
||||
"""
|
||||
config_var = key.lower().replace('.', '_')
|
||||
if check is None:
|
||||
setattr(
|
||||
config_inst, config_var, config_inst.get(key, default, cast, mask)
|
||||
)
|
||||
else:
|
||||
if type(config_inst.get(key, default, cast, mask)) is not check:
|
||||
if check is list:
|
||||
var = ast.literal_eval(
|
||||
config_inst.get(key, default, cast, mask)
|
||||
)
|
||||
setattr(config_inst, config_var, var)
|
||||
else:
|
||||
setattr(
|
||||
config_inst,
|
||||
config_var,
|
||||
config_inst.get(key, default, cast, mask),
|
||||
)
|
||||
|
||||
|
||||
# Create function to print cached logged messages and reset
|
||||
def process_cached_logs(
|
||||
config_inst: Type[config_inst_t], logger: logging.Logger
|
||||
):
|
||||
"""Prints the cached messages from :class:`~panaetius.config.Config`
|
||||
and resets the cache.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
config_inst : Type[config_inst_t]
|
||||
Instance of :class:`~panaetius.config.Config`.
|
||||
logger : logging.Logger
|
||||
Instance of the logger.
|
||||
"""
|
||||
for msg in config_inst.deferred_messages:
|
||||
logger.info(msg)
|
||||
config_inst.reset_log()
|
||||
@@ -1,54 +0,0 @@
|
||||
import logging
|
||||
from logging.handlers import RotatingFileHandler
|
||||
import os
|
||||
import sys
|
||||
|
||||
import panaetius
|
||||
from panaetius import CONFIG as CONFIG
|
||||
from panaetius import __header__ as __header__
|
||||
from panaetius import set_config as set_config
|
||||
|
||||
|
||||
panaetius.set_config(CONFIG, 'logging.path')
|
||||
panaetius.set_config(
|
||||
CONFIG,
|
||||
'logging.format',
|
||||
'{\n\t"time": "%(asctime)s",\n\t"file_name": "%(filename)s",'
|
||||
'\n\t"module": "%(module)s",\n\t"function":"%(funcName)s",\n\t'
|
||||
'"line_number": "%(lineno)s",\n\t"logging_level":'
|
||||
'"%(levelname)s",\n\t"message": "%(message)s"\n}',
|
||||
cast=str,
|
||||
)
|
||||
set_config(CONFIG, 'logging.level', 'INFO')
|
||||
|
||||
# Logging Configuration
|
||||
logger = logging.getLogger(__header__)
|
||||
loghandler_sys = logging.StreamHandler(sys.stdout)
|
||||
|
||||
# Checking if log path is set
|
||||
if CONFIG.logging_path:
|
||||
CONFIG.logging_path += (
|
||||
f'{__header__}.log'
|
||||
if CONFIG.logging_path[-1] == '/'
|
||||
else f'/{__header__}.log'
|
||||
)
|
||||
# Set default log file options
|
||||
set_config(CONFIG, 'logging.backup_count', 3, int)
|
||||
set_config(CONFIG, 'logging.rotate_bytes', 512000, int)
|
||||
|
||||
# Configure file handler
|
||||
loghandler_file = RotatingFileHandler(
|
||||
os.path.expanduser(CONFIG.logging_path),
|
||||
'a',
|
||||
CONFIG.logging_rotate_bytes,
|
||||
CONFIG.logging_backup_count,
|
||||
)
|
||||
|
||||
# Add to file formatter
|
||||
loghandler_file.setFormatter(logging.Formatter(CONFIG.logging_format))
|
||||
logger.addHandler(loghandler_file)
|
||||
|
||||
# Configure and add to stdout formatter
|
||||
loghandler_sys.setFormatter(logging.Formatter(CONFIG.logging_format))
|
||||
logger.addHandler(loghandler_sys)
|
||||
logger.setLevel(CONFIG.logging_level)
|
||||
@@ -2,7 +2,7 @@
|
||||
Access variables from a config file or an environment variable.
|
||||
|
||||
This module defines the `Config` class to interact and read variables from either a
|
||||
`config.toml` or an environment variable.
|
||||
`config.yml` or an environment variable.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
@@ -12,33 +12,44 @@ import os
|
||||
import pathlib
|
||||
from typing import Any
|
||||
|
||||
import toml
|
||||
# import toml
|
||||
import yaml
|
||||
|
||||
from panaetius.exceptions import KeyErrorTooDeepException, InvalidPythonException
|
||||
from panaetius.exceptions import KeyErrorTooDeepException
|
||||
|
||||
|
||||
class Config:
|
||||
"""The configuration class to access variables."""
|
||||
|
||||
def __init__(self, header_variable: str, config_path: str = "") -> None:
|
||||
def __init__(
|
||||
self,
|
||||
header_variable: str,
|
||||
config_path: str | None = None,
|
||||
skip_header_init: bool = False,
|
||||
) -> None:
|
||||
"""
|
||||
Create a Config object to set and access variables.
|
||||
|
||||
Args:
|
||||
header_variable (str): Your header variable name.
|
||||
config_path (str, optional): The path where the header directory is stored.
|
||||
Defaults to `~/.config`.
|
||||
Defaults to None on initialisation.
|
||||
skip_header_init (bool, optional): If True will not use a header
|
||||
subdirectory in the `config_path`. Defaults to False.
|
||||
|
||||
Examples:
|
||||
`config_path` defaults to None on initialisation but will be set to `~/.config`.
|
||||
|
||||
Example:
|
||||
A header of `data_analysis` with a config_path of `~/myapps` will define
|
||||
a config file in `~/myapps/data_analysis/config.toml`.
|
||||
a config file in `~/myapps/data_analysis/config.yml`.
|
||||
"""
|
||||
self.header_variable = header_variable
|
||||
self.config_path = (
|
||||
pathlib.Path(config_path)
|
||||
if config_path
|
||||
pathlib.Path(config_path).expanduser()
|
||||
if config_path is not None
|
||||
else pathlib.Path.home() / ".config"
|
||||
)
|
||||
self.skip_header_init = skip_header_init
|
||||
self._missing_config = self._check_config_file_exists()
|
||||
|
||||
# default logging options
|
||||
@@ -52,12 +63,18 @@ class Config:
|
||||
Return the contents of the config file. If missing returns an empty dictionary.
|
||||
|
||||
Returns:
|
||||
dict: The contents of the `.toml` loaded as a python dictionary.
|
||||
dict: The contents of the `.yml` loaded as a python dictionary.
|
||||
"""
|
||||
config_file_location = self.config_path / self.header_variable / "config.toml"
|
||||
if self.skip_header_init:
|
||||
config_file_location = self.config_path / "config.yml"
|
||||
else:
|
||||
config_file_location = (
|
||||
self.config_path / self.header_variable / "config.yml"
|
||||
)
|
||||
try:
|
||||
with open(config_file_location, "r", encoding="utf-8") as config_file:
|
||||
return dict(toml.load(config_file))
|
||||
# return dict(toml.load(config_file))
|
||||
return dict(yaml.load(stream=config_file, Loader=yaml.SafeLoader))
|
||||
except FileNotFoundError:
|
||||
return {}
|
||||
|
||||
@@ -67,8 +84,8 @@ class Config:
|
||||
|
||||
The key can either be one (`value`) or two (`data.value`) levels deep.
|
||||
|
||||
A key of (`value`) (with a header of `data_analysis`) would refer to a
|
||||
`config.toml` of:
|
||||
A key of `value` (with a header of `data_analysis`) would refer to a
|
||||
`config.yml` of:
|
||||
|
||||
```
|
||||
[data_analysis]
|
||||
@@ -77,7 +94,7 @@ class Config:
|
||||
|
||||
or an environment variable of `DATA_ANALYSIS_VALUE="'some value'"`.
|
||||
|
||||
A key of (`data.value`) would refer to a `config.toml` of:
|
||||
A key of `data.value` would refer to a `config.yml` of:
|
||||
```
|
||||
[data_analysis.data]
|
||||
value = "some value"
|
||||
@@ -101,7 +118,10 @@ class Config:
|
||||
return self._get_env_value(env_key, default)
|
||||
|
||||
def _check_config_file_exists(self) -> bool:
|
||||
config_file_location = self.config_path / self.header_variable / "config.toml"
|
||||
if self.skip_header_init is False:
|
||||
config_file_location = self.config_path / self.header_variable / "config.yml"
|
||||
else:
|
||||
config_file_location = self.config_path / "config.yml"
|
||||
try:
|
||||
with open(config_file_location, "r", encoding="utf-8"):
|
||||
return False
|
||||
@@ -163,7 +183,8 @@ class Config:
|
||||
try:
|
||||
return ast.literal_eval(value)
|
||||
except (ValueError, SyntaxError):
|
||||
raise InvalidPythonException(f"{value} is not valid Python.") # noqa
|
||||
# string without spaces: ValueError, with spaces; SyntaxError
|
||||
return value
|
||||
|
||||
def __load_default_value(self, default: Any) -> Any: # noqa
|
||||
return default
|
||||
|
||||
@@ -98,11 +98,11 @@ class LoggingData(metaclass=ABCMeta):
|
||||
@property
|
||||
@abstractmethod
|
||||
def format(self) -> str:
|
||||
pass
|
||||
raise NotImplementedError
|
||||
|
||||
@abstractmethod
|
||||
def __init__(self, logging_level: str):
|
||||
self.logging_level = logging_level
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
class SimpleLogger(LoggingData):
|
||||
|
||||
3
panaetius/utilities/__init__.py
Normal file
3
panaetius/utilities/__init__.py
Normal file
@@ -0,0 +1,3 @@
|
||||
"""General utilities."""
|
||||
|
||||
from panaetius.utilities.squasher import Squash
|
||||
64
panaetius/utilities/squasher.py
Normal file
64
panaetius/utilities/squasher.py
Normal file
@@ -0,0 +1,64 @@
|
||||
"""Squash a json object or Python dictionary into a single level dictionary."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from copy import deepcopy
|
||||
import itertools
|
||||
from typing import Iterator, Tuple
|
||||
|
||||
|
||||
class Squash:
|
||||
"""Squash a json object or Python dictionary into a single level dictionary."""
|
||||
|
||||
def __init__(self, data: dict) -> None:
|
||||
"""
|
||||
Create a Squash object to squash data into a single level dictionary.
|
||||
|
||||
Args:
|
||||
data (dict): [description]
|
||||
|
||||
Example:
|
||||
squashed_data = Squash(my_data)
|
||||
|
||||
squashed_data.as_dict
|
||||
"""
|
||||
self.data = data
|
||||
|
||||
@property
|
||||
def as_dict(self) -> dict:
|
||||
"""
|
||||
Return the squashed data as a dictionary.
|
||||
|
||||
Returns:
|
||||
dict: The original data squashed as a dict.
|
||||
"""
|
||||
return self._squash()
|
||||
|
||||
@staticmethod
|
||||
def _unpack_dict(
|
||||
key: str, value: dict | list | str
|
||||
) -> Iterator[Tuple[str, dict | list | str]]:
|
||||
if isinstance(value, dict):
|
||||
for sub_key, sub_value in value.items():
|
||||
temporary_key = f"{key}_{sub_key}"
|
||||
yield temporary_key, sub_value
|
||||
elif isinstance(value, list):
|
||||
for index, sub_value in enumerate(value):
|
||||
temporary_key = f"{key}_{index}"
|
||||
yield temporary_key, sub_value
|
||||
else:
|
||||
yield key, value
|
||||
|
||||
def _squash(self) -> dict:
|
||||
result = deepcopy(self.data)
|
||||
while True:
|
||||
result = dict(
|
||||
itertools.chain.from_iterable(
|
||||
itertools.starmap(self._unpack_dict, result.items())
|
||||
)
|
||||
)
|
||||
if not any(
|
||||
isinstance(value, dict) for value in result.values()
|
||||
) and not any(isinstance(value, list) for value in result.values()):
|
||||
break
|
||||
return result
|
||||
16
poetry.lock
generated
16
poetry.lock
generated
@@ -421,14 +421,6 @@ python-versions = "*"
|
||||
[package.dependencies]
|
||||
pylint = ">=1.7"
|
||||
|
||||
[[package]]
|
||||
name = "pylite"
|
||||
version = "0.1.0"
|
||||
description = "Intract with sqlite3 in python as simple as it can be."
|
||||
category = "main"
|
||||
optional = false
|
||||
python-versions = "*"
|
||||
|
||||
[[package]]
|
||||
name = "pyparsing"
|
||||
version = "2.4.7"
|
||||
@@ -504,7 +496,7 @@ testing = ["filelock"]
|
||||
name = "pyyaml"
|
||||
version = "6.0"
|
||||
description = "YAML parser and emitter for Python"
|
||||
category = "dev"
|
||||
category = "main"
|
||||
optional = false
|
||||
python-versions = ">=3.6"
|
||||
|
||||
@@ -621,7 +613,7 @@ testing = ["pytest (>=4.6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytes
|
||||
[metadata]
|
||||
lock-version = "1.1"
|
||||
python-versions = "^3.7"
|
||||
content-hash = "468d1aa5e0c440262f6041ad859358a84ef32462941aa6f3ba71838a52cc1ced"
|
||||
content-hash = "f68e5ab35a155ce5ea567b670f93f4678b6c65d1335017b21431b315297a0410"
|
||||
|
||||
[metadata.files]
|
||||
astroid = [
|
||||
@@ -834,10 +826,6 @@ pylint-plugin-utils = [
|
||||
{file = "pylint-plugin-utils-0.6.tar.gz", hash = "sha256:57625dcca20140f43731311cd8fd879318bf45a8b0fd17020717a8781714a25a"},
|
||||
{file = "pylint_plugin_utils-0.6-py3-none-any.whl", hash = "sha256:2f30510e1c46edf268d3a195b2849bd98a1b9433229bb2ba63b8d776e1fc4d0a"},
|
||||
]
|
||||
pylite = [
|
||||
{file = "pylite-0.1.0-py3-none-any.whl", hash = "sha256:eb46f5beb1f2102672fd4355c013ac2feebc0df284d65f7711f2041a0a410141"},
|
||||
{file = "pylite-0.1.0.tar.gz", hash = "sha256:e338d20d3f8f72dd84d1e58f2fd6dba008d593e0cfacfb5fbdd5a297b830628e"},
|
||||
]
|
||||
pyparsing = [
|
||||
{file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"},
|
||||
{file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "panaetius"
|
||||
version = "1.1"
|
||||
version = "2.2.1"
|
||||
description = "Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly formatted logger instance."
|
||||
license = "MIT"
|
||||
authors = ["dtomlinson <dtomlinson@panaetius.co.uk>"]
|
||||
@@ -25,7 +25,7 @@ classifiers = [
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.7"
|
||||
toml = "^0.10.0"
|
||||
pylite = "^0.1.0"
|
||||
PyYAML = "^6.0"
|
||||
|
||||
[tool.poetry.dev-dependencies]
|
||||
prospector = {extras = ["with_bandit", "with_mypy"], version = "^1.5.1"}
|
||||
|
||||
109
rewrite.todo
109
rewrite.todo
@@ -1,70 +1,53 @@
|
||||
Coding:
|
||||
No Config File:
|
||||
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25)
|
||||
needs to be lower case in the toml, need a check for this
|
||||
|
||||
Config File:
|
||||
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25)
|
||||
needs to be lower case in the toml, need a check for this
|
||||
|
||||
Logging:
|
||||
✔ Create SimpleLogger, AdvancedLogger, CustomLogger classes @done(21-10-16 16:22)
|
||||
should simply have the different logging strings to output
|
||||
should both specify whether to save to file or not
|
||||
✔ Logging path should take by default the config path unless overwritten? @done(21-10-16 23:49)
|
||||
|
||||
Errors:
|
||||
✔ Check logging path + config path are valid, if not raise error. @done(21-10-18 00:04)
|
||||
✔ Add tests for these. @done(21-10-18 00:04)
|
||||
✔ Check for a key > 2 levels, raise custom error, write test @done(21-10-17 23:30)
|
||||
|
||||
Linting:
|
||||
✔ Check all functions and annotations. @done(21-10-18 01:07)
|
||||
|
||||
Docstrings:
|
||||
✔ Write the docstrings for public functions/methods. @done(21-10-18 02:29)
|
||||
|
||||
Functionality:
|
||||
✔ When both a config file and a env var is found, use the env var. @done(21-10-18 00:38)
|
||||
|
||||
Testing:
|
||||
To Write:
|
||||
☐ Test the Config file skipping header with `skip_header_init`
|
||||
☐ Document coverage commands
|
||||
`coverage run --source=./panaetius -m pytest`
|
||||
`coverage report` & `coverage html` > gives ./htmlcov/index.html
|
||||
☐ Document for abstract methods should raise NotImplementedError
|
||||
☐ Document https://stackoverflow.com/a/9212387
|
||||
Documentation:
|
||||
☐ Rewrite documentation using `mkdocs` and using `.md`. @2h
|
||||
☐ Rewrite documentation using `mkdocs` and using `.md`.
|
||||
☐ Update the metadata in the `pyproject.toml`.
|
||||
☐ Create a new `Readme.md` and remove the `.rst`.
|
||||
☐ Document the logging strategy
|
||||
CLI tools should use `logger.critical` and raise SystemExit(1)
|
||||
Libraries should raise custom errors and have a `logger.critical(exec_info=1)`
|
||||
|
||||
Misc:
|
||||
☐ Use the python runner to build the docs & run the tests (including coverage html)
|
||||
coverage run -m pytest && coverage report && coverage html
|
||||
☐ document this in trilium
|
||||
|
||||
Tests:
|
||||
Bugfixes:
|
||||
✔ If loading from a default, don't covert to TOML @done(21-10-17 20:33)
|
||||
✔ Env Vars should be given as python objects @done(21-10-17 20:33)
|
||||
The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.
|
||||
use ast.literal_eval()
|
||||
https://docs.python.org/3/library/ast.html#ast.literal_eval
|
||||
|
||||
__init__:
|
||||
✔ Test default config path set to "~/.config" @done(21-10-17 17:25)
|
||||
✔ Test config path is set when passed in @done(21-10-17 17:25)
|
||||
|
||||
config property:
|
||||
✔ Check testing config file is returned as dict @done(21-10-17 17:25)
|
||||
✔ Check _self.missing_config and empty dict is returned @done(21-10-17 17:25)
|
||||
|
||||
get_value:
|
||||
config_file:
|
||||
✔ Arrays & tables loaded correctly from config file @done(21-10-17 20:34)
|
||||
✔ test when key length is 1 the value is returned @done(21-10-17 18:55)
|
||||
✔ test when key length is 2 the value is returned @done(21-10-17 18:55)
|
||||
✔ test when key not found and no env var default is loaded @done(21-10-17 19:01)
|
||||
✔ test bool's are properly converted @done(21-10-17 19:01)
|
||||
✔ test when key not found and env var is set value is loaded @done(21-10-17 20:43)
|
||||
|
||||
env_var:
|
||||
✔ check if env key is missing the default is read in @done(21-10-17 20:55)
|
||||
✔ check if env key is present the values are read in @done(21-10-17 22:24)
|
||||
✔ parametrise a test to read in values form env vars and they're set correctly @done(21-10-17 22:24)
|
||||
✔ test that the env var is valid python @done(21-10-18 01:03)
|
||||
|
||||
library:
|
||||
✔ test set_config works @done(21-10-17 23:29)
|
||||
Archive:
|
||||
✘ Bump the version to release 2.0 @cancelled(21-10-23 05:36) @project(Misc)
|
||||
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.No Config File)
|
||||
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.Config File)
|
||||
✔ Create SimpleLogger, AdvancedLogger, CustomLogger classes @done(21-10-16 16:22) @project(Coding.Logging)
|
||||
✔ Logging path should take by default the config path unless overwritten? @done(21-10-16 23:49) @project(Coding.Logging)
|
||||
✔ Check logging path + config path are valid, if not raise error. @done(21-10-18 00:04) @project(Coding.Errors)
|
||||
✔ Add tests for these. @done(21-10-18 00:04) @project(Coding.Errors)
|
||||
✔ Check for a key > 2 levels, raise custom error, write test @done(21-10-17 23:30) @project(Coding.Errors)
|
||||
✔ Check all functions and annotations. @done(21-10-18 01:07) @project(Coding.Linting)
|
||||
✔ Write the docstrings for public functions/methods. @done(21-10-18 02:29) @project(Coding.Docstrings)
|
||||
✔ When both a config file and a env var is found, use the env var. @done(21-10-18 00:38) @project(Coding.Functionality)
|
||||
✔ If loading from a default, don't covert to TOML @done(21-10-17 20:33) @project(Tests.Bugfixes)
|
||||
✔ Env Vars should be given as python objects @done(21-10-17 20:33) @project(Tests.Bugfixes)
|
||||
The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.
|
||||
use ast.literal_eval()
|
||||
https://docs.python.org/3/library/ast.html#ast.literal_eval
|
||||
✔ Test default config path set to "~/.config" @done(21-10-17 17:25) @project(Tests.__init__)
|
||||
✔ Test config path is set when passed in @done(21-10-17 17:25) @project(Tests.__init__)
|
||||
✔ Check testing config file is returned as dict @done(21-10-17 17:25) @project(Tests.config property)
|
||||
✔ Check _self.missing_config and empty dict is returned @done(21-10-17 17:25) @project(Tests.config property)
|
||||
✔ Arrays & tables loaded correctly from config file @done(21-10-17 20:34) @project(Tests.get_value.config_file)
|
||||
✔ test when key length is 1 the value is returned @done(21-10-17 18:55) @project(Tests.get_value.config_file)
|
||||
✔ test when key length is 2 the value is returned @done(21-10-17 18:55) @project(Tests.get_value.config_file)
|
||||
✔ test when key not found and no env var default is loaded @done(21-10-17 19:01) @project(Tests.get_value.config_file)
|
||||
✔ test bool's are properly converted @done(21-10-17 19:01) @project(Tests.get_value.config_file)
|
||||
✔ test when key not found and env var is set value is loaded @done(21-10-17 20:43) @project(Tests.get_value.config_file)
|
||||
✔ check if env key is missing the default is read in @done(21-10-17 20:55) @project(Tests.get_value.env_var)
|
||||
✔ check if env key is present the values are read in @done(21-10-17 22:24) @project(Tests.get_value.env_var)
|
||||
✔ parametrise a test to read in values form env vars and they're set correctly @done(21-10-17 22:24) @project(Tests.get_value.env_var)
|
||||
✔ test that the env var is valid python @done(21-10-18 01:03) @project(Tests.get_value.env_var)
|
||||
✔ test set_config works @done(21-10-17 23:29) @project(Tests.library)
|
||||
|
||||
18
setup.py
18
setup.py
@@ -1,27 +1,25 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
from distutils.core import setup
|
||||
|
||||
package_dir = \
|
||||
{'': 'src'}
|
||||
from setuptools import setup
|
||||
|
||||
packages = \
|
||||
['panaetius']
|
||||
['panaetius', 'panaetius.utilities']
|
||||
|
||||
package_data = \
|
||||
{'': ['*']}
|
||||
|
||||
install_requires = \
|
||||
['pylite>=0.1.0,<0.2.0', 'toml>=0.10.0,<0.11.0']
|
||||
['PyYAML>=6.0,<7.0', 'toml>=0.10.0,<0.11.0']
|
||||
|
||||
setup_kwargs = {
|
||||
'name': 'panaetius',
|
||||
'version': '1.0.2',
|
||||
'description': 'Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly logger instance.',
|
||||
'long_description': 'Author\n=======\n\nDaniel Tomlinson (dtomlinson@panaetius.co.uk)\n\nRequires\n=========\n\n`>= python3.7`\n\nPython requirements\n====================\n\n- toml = "^0.10.0"\n- pylite = "^0.1.0"\n\nDocumentation\n==============\n\nRead the documentation on `read the docs`_.\n\n.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html\n\nInstallation\n==============\n\nYou can install ..:obj:`panaetius`\n\nEasy Way\n=========\n\nPython\n-------\n\nFrom pip\n~~~~~~~~~\n\nFrom local wheel\n~~~~~~~~~~~~~~~~~\n\nFrom source\n~~~~~~~~~~~~\n\nExample Usage\n==============\n\n',
|
||||
'version': '2.2.1',
|
||||
'description': 'Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly formatted logger instance.',
|
||||
'long_description': 'Author\n=======\n\nDaniel Tomlinson (dtomlinson@panaetius.co.uk)\n\nRequires\n=========\n\n`>= python3.7`\n\nPython requirements\n====================\n\n- toml = "^0.10.0"\n- pylite = "^0.1.0"\n\nDocumentation\n==============\n\nRead the documentation on `read the docs`_.\n\n.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html\n\nInstallation\n==============\n\nYou can install ``panaetius`` the following ways:\n\nPython\n-------\n\n.. Attention:: You should install in a python virtual environment\n\nFrom pypi using pip\n~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: bash\n\n pip install panaetius\n\nFrom local wheel\n~~~~~~~~~~~~~~~~~\n\nDownload the latest verion from the `releases`_ page.\n\n.. _releases: https://github.com/dtomlinson91/panaetius/releases\n\nInstall with pip:\n\n.. code-block:: bash\n\n pip install -U panaetius-1.0.2-py3-none-any.whl\n\n\nFrom source\n~~~~~~~~~~~~\n\nClone the repo and install using ``setup.py``:\n\n.. code-block:: bash\n\n python setup.py\n',
|
||||
'author': 'dtomlinson',
|
||||
'author_email': 'dtomlinson@panaetius.co.uk',
|
||||
'maintainer': None,
|
||||
'maintainer_email': None,
|
||||
'url': 'https://github.com/dtomlinson91/panaetius',
|
||||
'package_dir': package_dir,
|
||||
'packages': packages,
|
||||
'package_data': package_data,
|
||||
'install_requires': install_requires,
|
||||
|
||||
9
tests/data/without_header/config.yml
Normal file
9
tests/data/without_header/config.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
panaetius_testing:
|
||||
some_top_string: some_top_value
|
||||
second:
|
||||
some_second_string: some_second_value
|
||||
some_second_int: 1
|
||||
some_second_float: 1.0
|
||||
some_second_list: ["some", "second", "value"]
|
||||
some_second_table: { "first": ["some", "first", "value"] }
|
||||
some_second_table_bools: { "bool": [true, false] }
|
||||
9
tests/data/without_logging/panaetius_testing/config.yml
Normal file
9
tests/data/without_logging/panaetius_testing/config.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
panaetius_testing:
|
||||
some_top_string: some_top_value
|
||||
second:
|
||||
some_second_string: some_second_value
|
||||
some_second_int: 1
|
||||
some_second_float: 1.0
|
||||
some_second_list: ["some", "second", "value"]
|
||||
some_second_table: { "first": ["some", "first", "value"] }
|
||||
some_second_table_bools: { "bool": [true, false] }
|
||||
@@ -29,6 +29,17 @@ def test_user_config_path_set(header, shared_datadir):
|
||||
assert str(config.config_path) == config_path
|
||||
|
||||
|
||||
def test_user_config_path_without_header_dir_set(header, shared_datadir):
|
||||
# arrange
|
||||
config_path = str(shared_datadir / "without_header")
|
||||
|
||||
# act
|
||||
config = panaetius.Config(header, config_path, skip_header_init=True)
|
||||
|
||||
# assert
|
||||
assert str(config.config_path) == config_path
|
||||
|
||||
|
||||
# test config files
|
||||
|
||||
|
||||
@@ -44,6 +55,18 @@ def test_config_file_exists(header, shared_datadir):
|
||||
assert config._missing_config is False
|
||||
|
||||
|
||||
def test_config_file_without_header_dir_exists(header, shared_datadir):
|
||||
# arrange
|
||||
config_path = str(shared_datadir / "without_header")
|
||||
|
||||
# act
|
||||
config = panaetius.Config(header, config_path, skip_header_init=True)
|
||||
_ = config.config
|
||||
|
||||
# assert
|
||||
assert config._missing_config is False
|
||||
|
||||
|
||||
def test_config_file_contents_read_success(
|
||||
header, shared_datadir, testing_config_contents
|
||||
):
|
||||
@@ -106,7 +129,7 @@ def test_get_value_from_key(
|
||||
|
||||
def test_get_value_environment_var_override(header, shared_datadir):
|
||||
# arrange
|
||||
os.environ[f"{header.upper()}_SOME_TOP_STRING"] = '"some_overridden_value"'
|
||||
os.environ[f"{header.upper()}_SOME_TOP_STRING"] = "some_overridden_value"
|
||||
config_path = str(shared_datadir / "without_logging")
|
||||
config = panaetius.Config(header, config_path)
|
||||
panaetius.set_config(config, "some_top_string")
|
||||
@@ -158,7 +181,7 @@ def test_get_value_missing_key_from_default(header, shared_datadir):
|
||||
|
||||
def test_get_value_missing_key_from_env(header, shared_datadir):
|
||||
# arrange
|
||||
os.environ[f"{header.upper()}_MISSING_KEY"] = '"some missing key"'
|
||||
os.environ[f"{header.upper()}_MISSING_KEY"] = "some missing key"
|
||||
|
||||
config_path = str(shared_datadir / "without_logging")
|
||||
config = panaetius.Config(header, config_path)
|
||||
@@ -205,7 +228,7 @@ def test_missing_config_read_from_default(header, shared_datadir):
|
||||
@pytest.mark.parametrize(
|
||||
"env_value,expected_value",
|
||||
[
|
||||
('"a missing string"', "a missing string"),
|
||||
("a missing string", "a missing string"),
|
||||
("1", 1),
|
||||
("1.0", 1.0),
|
||||
("True", True),
|
||||
@@ -237,6 +260,7 @@ def test_missing_config_read_from_env_var(
|
||||
del os.environ[f"{header.upper()}_MISSING_KEY_READ_FROM_ENV_VAR"]
|
||||
|
||||
|
||||
@pytest.mark.skip(reason="No longer needed as strings are loaded without quotes")
|
||||
def test_missing_config_read_from_env_var_invalid_python(header):
|
||||
# arrange
|
||||
os.environ[f"{header.upper()}_INVALID_PYTHON"] = "a string without quotes"
|
||||
|
||||
@@ -21,6 +21,7 @@ def test_logging_directory_does_not_exist(header, shared_datadir):
|
||||
assert str(logging_exception.value) == ""
|
||||
|
||||
|
||||
# TODO: change this test so it asserts the dir exists
|
||||
def test_logging_directory_does_exist(header, shared_datadir):
|
||||
# arrange
|
||||
config = Config(header)
|
||||
@@ -32,3 +33,5 @@ def test_logging_directory_does_exist(header, shared_datadir):
|
||||
|
||||
# assert
|
||||
assert isinstance(logger, logging.Logger)
|
||||
|
||||
# TODO: add tests to check that SimpleLogger, AdvancedLogger, CustomLogger work as intended
|
||||
|
||||
0
tests/test_utilities/__init__.py
Normal file
0
tests/test_utilities/__init__.py
Normal file
119
tests/test_utilities/test_squasher.py
Normal file
119
tests/test_utilities/test_squasher.py
Normal file
@@ -0,0 +1,119 @@
|
||||
import pytest
|
||||
|
||||
from panaetius import utilities
|
||||
|
||||
|
||||
def test_squashed_data(squashed_data, squashed_data_result):
|
||||
# act
|
||||
squashed_data_pre_squashed = utilities.squasher.Squash(squashed_data).as_dict
|
||||
|
||||
# assert
|
||||
assert squashed_data_pre_squashed == squashed_data_result
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def squashed_data():
|
||||
return {
|
||||
"destination_addresses": [
|
||||
"Washington, DC, USA",
|
||||
"Philadelphia, PA, USA",
|
||||
"Santa Barbara, CA, USA",
|
||||
"Miami, FL, USA",
|
||||
"Austin, TX, USA",
|
||||
"Napa County, CA, USA",
|
||||
],
|
||||
"origin_addresses": ["New York, NY, USA"],
|
||||
"rows": [
|
||||
{
|
||||
"elements": [
|
||||
{
|
||||
"distance": {"text": "227 mi", "value": 365468},
|
||||
"duration": {
|
||||
"text": "3 hours 54 mins",
|
||||
"value": 14064,
|
||||
},
|
||||
"status": "OK",
|
||||
},
|
||||
{
|
||||
"distance": {"text": "94.6 mi", "value": 152193},
|
||||
"duration": {"text": "1 hour 44 mins", "value": 6227},
|
||||
"status": "OK",
|
||||
},
|
||||
{
|
||||
"distance": {"text": "2,878 mi", "value": 4632197},
|
||||
"duration": {
|
||||
"text": "1 day 18 hours",
|
||||
"value": 151772,
|
||||
},
|
||||
"status": "OK",
|
||||
},
|
||||
{
|
||||
"distance": {"text": "1,286 mi", "value": 2069031},
|
||||
"duration": {
|
||||
"text": "18 hours 43 mins",
|
||||
"value": 67405,
|
||||
},
|
||||
"status": "OK",
|
||||
},
|
||||
{
|
||||
"distance": {"text": "1,742 mi", "value": 2802972},
|
||||
"duration": {"text": "1 day 2 hours", "value": 93070},
|
||||
"status": "OK",
|
||||
},
|
||||
{
|
||||
"distance": {"text": "2,871 mi", "value": 4620514},
|
||||
"duration": {
|
||||
"text": "1 day 18 hours",
|
||||
"value": 152913,
|
||||
},
|
||||
"status": "OK",
|
||||
},
|
||||
]
|
||||
}
|
||||
],
|
||||
"status": "OK",
|
||||
}
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def squashed_data_result():
|
||||
return {
|
||||
"destination_addresses_0": "Washington, DC, USA",
|
||||
"destination_addresses_1": "Philadelphia, PA, USA",
|
||||
"destination_addresses_2": "Santa Barbara, CA, USA",
|
||||
"destination_addresses_3": "Miami, FL, USA",
|
||||
"destination_addresses_4": "Austin, TX, USA",
|
||||
"destination_addresses_5": "Napa County, CA, USA",
|
||||
"origin_addresses_0": "New York, NY, USA",
|
||||
"rows_0_elements_0_distance_text": "227 mi",
|
||||
"rows_0_elements_0_distance_value": 365468,
|
||||
"rows_0_elements_0_duration_text": "3 hours 54 mins",
|
||||
"rows_0_elements_0_duration_value": 14064,
|
||||
"rows_0_elements_0_status": "OK",
|
||||
"rows_0_elements_1_distance_text": "94.6 mi",
|
||||
"rows_0_elements_1_distance_value": 152193,
|
||||
"rows_0_elements_1_duration_text": "1 hour 44 mins",
|
||||
"rows_0_elements_1_duration_value": 6227,
|
||||
"rows_0_elements_1_status": "OK",
|
||||
"rows_0_elements_2_distance_text": "2,878 mi",
|
||||
"rows_0_elements_2_distance_value": 4632197,
|
||||
"rows_0_elements_2_duration_text": "1 day 18 hours",
|
||||
"rows_0_elements_2_duration_value": 151772,
|
||||
"rows_0_elements_2_status": "OK",
|
||||
"rows_0_elements_3_distance_text": "1,286 mi",
|
||||
"rows_0_elements_3_distance_value": 2069031,
|
||||
"rows_0_elements_3_duration_text": "18 hours 43 mins",
|
||||
"rows_0_elements_3_duration_value": 67405,
|
||||
"rows_0_elements_3_status": "OK",
|
||||
"rows_0_elements_4_distance_text": "1,742 mi",
|
||||
"rows_0_elements_4_distance_value": 2802972,
|
||||
"rows_0_elements_4_duration_text": "1 day 2 hours",
|
||||
"rows_0_elements_4_duration_value": 93070,
|
||||
"rows_0_elements_4_status": "OK",
|
||||
"rows_0_elements_5_distance_text": "2,871 mi",
|
||||
"rows_0_elements_5_distance_value": 4620514,
|
||||
"rows_0_elements_5_duration_text": "1 day 18 hours",
|
||||
"rows_0_elements_5_duration_value": 152913,
|
||||
"rows_0_elements_5_status": "OK",
|
||||
"status": "OK",
|
||||
}
|
||||
Reference in New Issue
Block a user