gdwr / classy-config Goto Github PK

View Code? Open in Web Editor NEW

8.0 8.0 2.0 3.46 MB

Say bye-bye to your config.py

Home Page: https://gdwr.github.io/classy-config/

License: MIT License

Python 96.81% Dockerfile 3.19%

config python settings

classy-config's People

Contributors

Stargazers

Watchers

Forkers

fisher60 minalike

classy-config's Issues

Read config file once

This should only read the config file once, the current implementation does it for each setting loaded.

classy-config/classy_config/classy_config.py

Lines 23 to 29 in 66b94fd

    
           def _get_raw_config_file(self) -> dict: 
        
               with open(self.config_file, "r") as f: 
        
                   return json.load(f) 
        
           @property 
        
           def raw_config(self) -> dict: 
        
               return self._get_raw_config_file()

Auto documentation

Add docstrings, and auto documentation generation from them.

Add Guides

https://gdwr.github.io/classy-config/source/guides/index.html

Add an environment variable loader

We want a way to access config/settings that are stored in the environment.

Config values should be CAsEinSenItIVE

Seen some issues with using environemnet variable loader, as they are all uppercase.

We should just make ConfigValue "variable_path" case insensitive.

Test to ensure config values cannot be mutated

I want to ensure that if a config value is changed in a function scope, for whatever reason, this doesn't effect the config value within other scopes.

Docs about why classy config helps with testability.

Describe how making your settings gathered via the params means you can easily override them for tests.

Add feature list to README.md

Add a feature list to the README.md

i.e.

Features;

Supports multiple config types
- .json
- .toml
- .env
Supports Static Analyisis
Pydantic
...

Fix lint errors occurring on every lint run

Currently linting using poetry run flake8 results in a fairly long list of lint errors. This makes it difficult to check linting prior to pushing changes and waiting for the CI to return lint errors. It is likely that a config is needed to ignore these files since they are passing linting in the Action.

.\examples\custom_loader\main.py:6:1: D103 Missing docstring in public function
.\examples\simple\main.py:3:1: I101 Imported names are in the wrong order. Should be ConfigValue, register_config
.\examples\simple\main.py:3:1: I202 Additional newline in a group of imports. 'from classy_config import register_config, ConfigValue' is identified as Third Party and 'import 
pygame' is identified as Third Party.
.\examples\simple\main.py:18:1: D101 Missing docstring in public class
.\examples\simple\main.py:22:9: ANN001 Missing type annotation for function argument 'size'
.\examples\simple\main.py:22:14: B008 Do not perform function calls in argument defaults.  The call is performed only once at function definition time. All calls to your function will reuse the result of that definition-time function call.  If this is intended, assign the function call to a module-level variable and use that variable as a default value.
.\examples\simple\main.py:23:9: ANN001 Missing type annotation for function argument 'x_speed'
.\examples\simple\main.py:23:17: B008 Do not perform function calls in argument defaults.  The call is performed only once at function definition time. All calls to your function will reuse the result of that definition-time function call.  If this is intended, assign the function call to a module-level variable and use that variable as a default value.
.\examples\simple\main.py:24:9: ANN001 Missing type annotation for function argument 'y_speed'    
.\examples\simple\main.py:24:17: B008 Do not perform function calls in argument defaults.  The call is performed only once at function definition time. All calls to your function will reuse the result of that definition-time function call.  If this is intended, assign the function call to a module-level variable and use that variable as a default value.
.\examples\simple\main.py:38:1: D102 Missing docstring in public method
.\examples\simple\main.py:38:21: ANN201 Missing return type annotation for public function

self = typing.List, args = ([1, 2, 3, 4],), kwargs = {}

    def __call__(self, *args, **kwargs):
        if not self._inst:
>           raise TypeError(f"Type {self._name} cannot be instantiated; "
                            f"use {self.__origin__.__name__}() instead")
E           TypeError: Type List cannot be instantiated; use list() instead

	def _get_raw_config_file(self) -> dict:
	with open(self.config_file, "r") as f:
	return json.load(f)

	@property
	def raw_config(self) -> dict:
	return self._get_raw_config_file()