Skip to content

Commit

Permalink
chore: ruff format all source
Browse files Browse the repository at this point in the history
  • Loading branch information
srfoster65 committed Nov 13, 2023
1 parent 69f9eaf commit e973e85
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 34 deletions.
4 changes: 2 additions & 2 deletions src/arg_init/_arg_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ def _read_config(
config = read_config(config_name)
logger.debug("Checking for section '%s' in config file", section_name)
if config and section_name in config:
logger.debug("config=%s", config[section_name])
return config[section_name]
logger.debug("config=%s", config[section_name])
return config[section_name]
logger.debug("No section '%s' data found", section_name)
return {}
logger.debug("skipping file based config based on priorities")
Expand Down
4 changes: 1 addition & 3 deletions tests/test_arg_priority.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@ def test_matrix(self, prefix, arg_value, envs, config, defaults, expected, fs):
"""

def test(arg1): # pylint: disable=unused-argument
args = FunctionArgInit(
env_prefix=prefix, defaults=defaults, priorities=ARG_PRIORITY
).args
args = FunctionArgInit(env_prefix=prefix, defaults=defaults, priorities=ARG_PRIORITY).args
assert args[expected.key] == expected.value

if config:
Expand Down
8 changes: 2 additions & 6 deletions tests/test_arguments.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ class TestArguments:
(None, None, '{"test": {"arg1": ""}}', DEFAULTS, Expected("arg1", "")),
],
)
def test_logical_false_values(
self, arg_value, envs, config, defaults, expected, fs
):
def test_logical_false_values(self, arg_value, envs, config, defaults, expected, fs):
"""
Priority Order
1. Test 0 argument
Expand All @@ -49,9 +47,7 @@ def test_logical_false_values(
"""

def test(arg1): # pylint: disable=unused-argument
args = FunctionArgInit(
defaults=defaults, priority=PRIORITY_ORDER
).args
args = FunctionArgInit(defaults=defaults, priority=PRIORITY_ORDER).args
print(args[expected.key], expected.value)
assert args[expected.key] == expected.value

Expand Down
16 changes: 11 additions & 5 deletions tests/test_class_arg_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from arg_init import ClassArgInit


Expected = namedtuple('Expected', 'key value')
Expected = namedtuple("Expected", "key value")


class TestClassArgInit:
Expand All @@ -21,66 +21,72 @@ def test_class(self, fs): # pylint: disable=unused-argument
"""
Test ArgInit on a class method
"""

class Test:
"""Test Class"""

def __init__(self, arg1): # pylint: disable=unused-argument
ClassArgInit()
assert self._arg1 == arg1_value # pylint: disable=no-member

arg1_value = "arg1_value"
Test(arg1_value)


def test_protect_attr_false_sets_attr(self, fs): # pylint: disable=unused-argument
"""
Test ArgInit on a class method
"""

class Test:
"""Test Class"""

def __init__(self, arg1): # pylint: disable=unused-argument
ClassArgInit(protect_attrs=False)
assert self.arg1 == arg1_value # pylint: disable=no-member

arg1_value = "arg1_value"
Test(arg1_value)


def test_exception_raised_if_protected_attr_exists(self, fs): # pylint: disable=unused-argument
"""
Test exception raised if attempting to set an attribute that already exists
"""

class Test:
"""Test Class"""

def __init__(self, arg1=None): # pylint: disable=unused-argument
self._arg1 = "other_value"
ClassArgInit()

with pytest.raises(AttributeError):
Test()


def test_exception_raised_if_non_protected_attr_exists(self, fs): # pylint: disable=unused-argument
"""
Test exception raised if attempting to set an attribute that already exists.
Verify "_" is not used as a prefix to attr when protect_args=False.
"""

class Test:
"""Test Class"""

def __init__(self, arg1=None): # pylint: disable=unused-argument
self.arg1 = "other_value"
ClassArgInit(protect_attrs=False)

with pytest.raises(AttributeError):
Test()


def test_set_attrs_false_does_not_set_attrs(self, fs): # pylint: disable=unused-argument
"""
Test exception raised if attempting to set an attribute that already exists.
Verify "_" is not used as a prefix to attr when protect_args=False.
"""

class Test:
"""Test Class"""

def __init__(self, arg1=None): # pylint: disable=unused-argument
self.arg1 = "other_value"
ClassArgInit(set_attrs=False)
Expand Down
12 changes: 6 additions & 6 deletions tests/test_env_priority.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from arg_init import FunctionArgInit, ArgDefaults, Priority


Expected = namedtuple('Expected', 'key value')
Expected = namedtuple("Expected", "key value")


# Common test defaults
Expand Down Expand Up @@ -43,6 +43,7 @@ def test_priority(self, prefix, arg_value, envs, config, defaults, expected, fs)
3. Default is defined - Default is used
4. Nothing defined - None is used
"""

def test(arg1): # pylint: disable=unused-argument
args = FunctionArgInit(env_prefix=prefix, defaults=defaults).args
assert args[expected.key] == expected.value
Expand All @@ -54,7 +55,6 @@ def test(arg1): # pylint: disable=unused-argument
mp.setenv(env, value)
test(arg1=arg_value)


def test_function_default(self, fs): # pylint: disable=unused-argument
"""
Test function default is used if set and no arg passed in.
Expand All @@ -67,11 +67,11 @@ def test(arg1="func_default"): # pylint: disable=unused-argument

test()


def test_multiple_args(self, fs): # pylint: disable=unused-argument
"""
Test initialisation from args when no envs defined
"""

def test(arg1, arg2): # pylint: disable=unused-argument
"""Test Class"""
args = FunctionArgInit().args
Expand All @@ -82,11 +82,11 @@ def test(arg1, arg2): # pylint: disable=unused-argument
arg2_value = "arg2_value"
test(arg1_value, arg2_value)


def test_multiple_envs(self, fs): # pylint: disable=unused-argument
"""
Test initialised from envs
"""

def test(arg1, arg2): # pylint: disable=unused-argument
"""Test Class"""
args = FunctionArgInit().args
Expand All @@ -102,17 +102,17 @@ def test(arg1, arg2): # pylint: disable=unused-argument
mp.setenv(env2, env2_value)
test("arg1_value", "arg2_value")


def test_multiple_mixed(self, fs): # pylint: disable=unused-argument
"""
Test mixed initialisation
arg1 - env priority
arg2 - env, arg = None
arg3 - arg - env not set
"""

def test(arg1, arg2, arg3): # pylint: disable=unused-argument
"""Test Class"""
args = FunctionArgInit().args
args = FunctionArgInit().args
assert args["arg1"] == env1_value
assert args["arg2"] == env2_value
assert args["arg3"] == arg3_value
Expand Down
11 changes: 9 additions & 2 deletions tests/test_env_variants.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from arg_init import FunctionArgInit, ArgDefaults

Expected = namedtuple('Expected', 'key value')
Expected = namedtuple("Expected", "key value")


class TestEnvVariants:
Expand All @@ -20,7 +20,13 @@ class TestEnvVariants:
"prefix, arg_value, envs, defaults, expected",
[
("prefix", None, {"PREFIX_ARG1": "env1_value"}, None, Expected("arg1", "env1_value")),
("prefix", None, {"ENV1": "env1_value"}, [ArgDefaults(name="arg1", alt_name="ENV1")], Expected("arg1", "env1_value")),
(
"prefix",
None,
{"ENV1": "env1_value"},
[ArgDefaults(name="arg1", alt_name="ENV1")],
Expected("arg1", "env1_value"),
),
],
)
def test_env_variants(self, prefix, arg_value, envs, defaults, expected, fs): # pylint: disable=unused-argument
Expand All @@ -31,6 +37,7 @@ def test_env_variants(self, prefix, arg_value, envs, defaults, expected, fs): #
2. Default env_name (Prefix not used) - Env is used
"""

def test(arg1): # pylint: disable=unused-argument
args = FunctionArgInit(env_prefix=prefix, defaults=defaults).args
assert args[expected.key] == expected.value
Expand Down
3 changes: 2 additions & 1 deletion tests/test_function_arg_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from arg_init import FunctionArgInit


Expected = namedtuple('Expected', 'key value')
Expected = namedtuple("Expected", "key value")


class TestFunctionArgInit:
Expand All @@ -19,6 +19,7 @@ def test_function(self, fs): # pylint: disable=unused-argument
"""
Test FunctionArgInit
"""

def test(arg1): # pylint: disable=unused-argument
"""Test Class"""
arg_init = FunctionArgInit()
Expand Down
8 changes: 5 additions & 3 deletions tests/test_kwargs.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from arg_init import ClassArgInit, FunctionArgInit


Expected = namedtuple('Expected', 'key value')
Expected = namedtuple("Expected", "key value")


class TestKwargs:
Expand All @@ -19,6 +19,7 @@ def test_kwargs_not_used(self, fs): # pylint: disable=unused-argument
"""
Test kwargs are ignored if not explicity enabled
"""

def test(arg1, **kwargs): # pylint: disable=unused-argument
"""Test Class"""
args = FunctionArgInit(use_kwargs=True).args
Expand All @@ -31,11 +32,11 @@ def test(arg1, **kwargs): # pylint: disable=unused-argument
kwargs = {kwarg1: kwarg1_value}
test(arg1_value, **kwargs)


def test_kwargs_used_for_function(self, fs): # pylint: disable=unused-argument
"""
Test kwargs are processed if enabled
"""

def test(arg1, **kwargs): # pylint: disable=unused-argument
"""Test Class"""
args = FunctionArgInit(use_kwargs=True).args
Expand All @@ -48,13 +49,14 @@ def test(arg1, **kwargs): # pylint: disable=unused-argument
kwargs = {kwarg1: kwarg1_value}
test(arg1_value, **kwargs)


def test_kwargs_used_for_class(self, fs): # pylint: disable=unused-argument
"""
Test kwargs are processed if enabled
"""

class Test:
"""Test Class"""

def __init__(self, arg1, **kwargs): # pylint: disable=unused-argument
args = ClassArgInit(use_kwargs=True).args
assert args["arg1"] == arg1_value
Expand Down
8 changes: 2 additions & 6 deletions tests/test_print.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,8 @@ def test_defaults_repr(self, fs): # pylint: disable=unused-argument
Test repr() returns correct string
"""

arg1_defaults = ArgDefaults(
name="arg1", default_value="default", alt_name="ENV"
)
arg1_defaults = ArgDefaults(name="arg1", default_value="default", alt_name="ENV")
defaults = [arg1_defaults]
out = repr(defaults)
expected = (
"<ArgDefaults(name=arg1, default_value=default, alt_name=ENV)>"
)
expected = "<ArgDefaults(name=arg1, default_value=default, alt_name=ENV)>"
assert expected in out

0 comments on commit e973e85

Please sign in to comment.