update values into class attrs from OsEnvironment or Ini/Json File
Project description
private_values
Designed to use private data like username/pwd kept secure in OsEnvironment or Ini/Json-File for your several home projects at ones.
And not open it in public.
CAUTION:
in requirements for other projects use fixed version! because it might be refactored so you would get exception soon.
Features
- load values to instance attrs from:
- Environment
- iniFile
- JsonFile
- attr access
- via any lettercase
see examples below - by instance attr
- via any lettercase
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class Cls:
data = PrivateAuthJson(_section="AUTH")
def connect(self):
name = self.data.NAME
name = self.data.NamE # case insensitive
- like dict key on instance
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class Cls:
data = PrivateAuthJson(_section="AUTH")
def connect(self):
name = self.data["NAME"]
name = self.data["NamE"] # case insensitive
License
See the LICENSE file for license rights and limitations (MIT).
Release history
See the HISTORY.md file for release history.
Installation
pip install private-values
Import
from private_values import *
GUIDE
use annotations for your param names (best practice!)
when instantiating if it will not get loaded these exact params from your private sources - RAISE!
but you could not use it and however keep access to all existed params in used section!
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class MyPrivateJson(PrivateJson):
NAME: str
PWD: str
name = MyPrivateJson().NAME
in example above you could simply use existed classes
from private_values import *
name = PrivateAuthJson().NAME
1. Env
from private_values import *
class Cls:
user = PrivateEnv["NAME"]
user = PrivateEnv.NAME
2. IniFile
- Use different sections
from private_values import *
class Cls:
user = PrivateIni(_section="CustomSection").NAME
- Change full settings
from private_values import *
class CustomIniValues(PrivateIni):
DIRPATH = "new/path/"
DIRPATH = pathlib.Path("new/path/")
FILENAME = "my.ini"
SECTION = "CustomSection"
class Cls:
user = CustomIniValues.NAME
- Without creating new class
from private_values import *
class Cls:
pv1 = PrivateIni(_filename="otherFilename").pv1
3. JsonFile
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class MyPrivateJson(PrivateJson):
SECTION = "AUTH"
NAME: str
PWD: str
class Cls:
data = MyPrivateJson()
def connect(self):
name = self.data.NAME
- use already created templates (PrivateAuthJson/PrivateTgBotAddressJson) for standard attributes
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class Cls:
data = PrivateAuthJson(_section="AUTH")
def connect(self):
name = self.data.NAME
4. Auto
you can use universal class
it will trying get all your annotated params from one source of Json/Ini/Env (in exact order)
in this case you cant use FileName and must use annotations!
# {"AUTH": {"NAME": "MyName", "PWD": "MyPwd"}}
from private_values import *
class MyPrivate(PrivateAuto):
SECTION = "AUTH"
NAME: str
PWD: str
name = MyPrivate().NAME
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for private_values-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a36a5a6a0346477e4dd973be3029516316d48c4a06dc424198f996b297c8e54d |
|
MD5 | 14508d9bd1bd9a62b73982f6a9c58fb3 |
|
BLAKE2b-256 | ba9a1689b00266c6be1e3890b82f8e7ce76dfa3e6791d832f35aa29f08ec5f66 |