From 801498570ec609d3558435a61a1ca9f45137dafd Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Fri, 1 Jan 2021 13:50:41 +0100 Subject: [PATCH] refactor: rename modules to reflect pep8 recommendations (#27) --- ansibledoctor/{Annotation.py => annotation.py} | 4 ++-- ansibledoctor/{Cli.py => cli.py} | 12 ++++++------ ansibledoctor/{Config.py => config.py} | 10 +++++----- ansibledoctor/{Contstants.py => contstants.py} | 0 .../{DocumentationGenerator.py => doc_generator.py} | 10 +++++----- .../{DocumentationParser.py => doc_parser.py} | 12 ++++++------ ansibledoctor/{Exception.py => exception.py} | 0 ansibledoctor/{FileRegistry.py => file_registry.py} | 6 +++--- ansibledoctor/{Utils.py => utils.py} | 4 ++-- pyproject.toml | 2 +- 10 files changed, 30 insertions(+), 30 deletions(-) rename ansibledoctor/{Annotation.py => annotation.py} (98%) rename ansibledoctor/{Cli.py => cli.py} (90%) rename ansibledoctor/{Config.py => config.py} (97%) rename ansibledoctor/{Contstants.py => contstants.py} (100%) rename ansibledoctor/{DocumentationGenerator.py => doc_generator.py} (96%) rename ansibledoctor/{DocumentationParser.py => doc_parser.py} (94%) rename ansibledoctor/{Exception.py => exception.py} (100%) rename ansibledoctor/{FileRegistry.py => file_registry.py} (92%) rename ansibledoctor/{Utils.py => utils.py} (98%) diff --git a/ansibledoctor/Annotation.py b/ansibledoctor/annotation.py similarity index 98% rename from ansibledoctor/Annotation.py rename to ansibledoctor/annotation.py index bb0b5f3..ece4dbb 100644 --- a/ansibledoctor/Annotation.py +++ b/ansibledoctor/annotation.py @@ -7,8 +7,8 @@ from collections import defaultdict import anyconfig -from ansibledoctor.Config import SingleConfig -from ansibledoctor.Utils import SingleLog +from ansibledoctor.config import SingleConfig +from ansibledoctor.utils import SingleLog class AnnotationItem: diff --git a/ansibledoctor/Cli.py b/ansibledoctor/cli.py similarity index 90% rename from ansibledoctor/Cli.py rename to ansibledoctor/cli.py index 0c941ec..9b74db6 100644 --- a/ansibledoctor/Cli.py +++ b/ansibledoctor/cli.py @@ -3,12 +3,12 @@ import argparse -import ansibledoctor.Exception +import ansibledoctor.exception from ansibledoctor import __version__ -from ansibledoctor.Config import SingleConfig -from ansibledoctor.DocumentationGenerator import Generator -from ansibledoctor.DocumentationParser import Parser -from ansibledoctor.Utils import SingleLog +from ansibledoctor.config import SingleConfig +from ansibledoctor.doc_generator import Generator +from ansibledoctor.doc_parser import Parser +from ansibledoctor.utils import SingleLog class AnsibleDoctor: @@ -74,7 +74,7 @@ class AnsibleDoctor: def _get_config(self): try: config = SingleConfig(args=self.args) - except ansibledoctor.Exception.ConfigError as e: + except ansibledoctor.exception.ConfigError as e: self.log.sysexit_with_message(e) try: diff --git a/ansibledoctor/Config.py b/ansibledoctor/config.py similarity index 97% rename from ansibledoctor/Config.py rename to ansibledoctor/config.py index 149aa73..068c723 100644 --- a/ansibledoctor/Config.py +++ b/ansibledoctor/config.py @@ -10,8 +10,8 @@ import ruamel.yaml from appdirs import AppDirs from jsonschema._utils import format_as_index -import ansibledoctor.Exception -from ansibledoctor.Utils import Singleton +import ansibledoctor.exception +from ansibledoctor.utils import Singleton config_dir = AppDirs("ansible-doctor").user_config_dir default_config_file = os.path.join(config_dir, "config.yml") @@ -185,7 +185,7 @@ class Config(): if '"{}" not set'.format(envname) in str(e): pass else: - raise ansibledoctor.Exception.ConfigError( + raise ansibledoctor.exception.ConfigError( "Unable to read environment variable", str(e) ) @@ -223,7 +223,7 @@ class Config(): ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError ) as e: message = "{} {}".format(e.context, e.problem) - raise ansibledoctor.Exception.ConfigError( + raise ansibledoctor.exception.ConfigError( "Unable to read config file {}".format(config), message ) @@ -271,7 +271,7 @@ class Config(): schema=format_as_index(list(e.relative_schema_path)[:-1]), message=e.message ) - raise ansibledoctor.Exception.ConfigError("Configuration error", schema_error) + raise ansibledoctor.exception.ConfigError("Configuration error", schema_error) return True diff --git a/ansibledoctor/Contstants.py b/ansibledoctor/contstants.py similarity index 100% rename from ansibledoctor/Contstants.py rename to ansibledoctor/contstants.py diff --git a/ansibledoctor/DocumentationGenerator.py b/ansibledoctor/doc_generator.py similarity index 96% rename from ansibledoctor/DocumentationGenerator.py rename to ansibledoctor/doc_generator.py index e14e747..27feec4 100644 --- a/ansibledoctor/DocumentationGenerator.py +++ b/ansibledoctor/doc_generator.py @@ -12,10 +12,10 @@ from jinja2 import Environment from jinja2 import FileSystemLoader from jinja2.filters import evalcontextfilter -import ansibledoctor.Exception -from ansibledoctor.Config import SingleConfig -from ansibledoctor.Utils import FileUtils -from ansibledoctor.Utils import SingleLog +import ansibledoctor.exception +from ansibledoctor.config import SingleConfig +from ansibledoctor.utils import FileUtils +from ansibledoctor.utils import SingleLog class Generator: @@ -89,7 +89,7 @@ class Generator: try: if not FileUtils.query_yes_no("Do you want to continue?"): self.log.sysexit_with_message("Aborted...") - except ansibledoctor.Exception.InputError as e: + except ansibledoctor.exception.InputError as e: self.logger.debug(str(e)) self.log.sysexit_with_message("Aborted...") diff --git a/ansibledoctor/DocumentationParser.py b/ansibledoctor/doc_parser.py similarity index 94% rename from ansibledoctor/DocumentationParser.py rename to ansibledoctor/doc_parser.py index ee855aa..c09a651 100644 --- a/ansibledoctor/DocumentationParser.py +++ b/ansibledoctor/doc_parser.py @@ -8,12 +8,12 @@ import anyconfig import ruamel.yaml from nested_lookup import nested_lookup -from ansibledoctor.Annotation import Annotation -from ansibledoctor.Config import SingleConfig -from ansibledoctor.Contstants import YAML_EXTENSIONS -from ansibledoctor.FileRegistry import Registry -from ansibledoctor.Utils import SingleLog -from ansibledoctor.Utils import UnsafeTag +from ansibledoctor.annotation import Annotation +from ansibledoctor.config import SingleConfig +from ansibledoctor.contstants import YAML_EXTENSIONS +from ansibledoctor.file_registry import Registry +from ansibledoctor.utils import SingleLog +from ansibledoctor.utils import UnsafeTag class Parser: diff --git a/ansibledoctor/Exception.py b/ansibledoctor/exception.py similarity index 100% rename from ansibledoctor/Exception.py rename to ansibledoctor/exception.py diff --git a/ansibledoctor/FileRegistry.py b/ansibledoctor/file_registry.py similarity index 92% rename from ansibledoctor/FileRegistry.py rename to ansibledoctor/file_registry.py index fd7e16c..d46d66b 100644 --- a/ansibledoctor/FileRegistry.py +++ b/ansibledoctor/file_registry.py @@ -6,9 +6,9 @@ import os import pathspec -from ansibledoctor.Config import SingleConfig -from ansibledoctor.Contstants import YAML_EXTENSIONS -from ansibledoctor.Utils import SingleLog +from ansibledoctor.config import SingleConfig +from ansibledoctor.contstants import YAML_EXTENSIONS +from ansibledoctor.utils import SingleLog class Registry: diff --git a/ansibledoctor/Utils.py b/ansibledoctor/utils.py similarity index 98% rename from ansibledoctor/Utils.py rename to ansibledoctor/utils.py index 4807285..1853c77 100644 --- a/ansibledoctor/Utils.py +++ b/ansibledoctor/utils.py @@ -9,7 +9,7 @@ from distutils.util import strtobool import colorama from pythonjsonlogger import jsonlogger -import ansibledoctor.Exception +import ansibledoctor.exception CONSOLE_FORMAT = "{}{}[%(levelname)s]{} %(message)s" JSON_FORMAT = "(asctime) (levelname) (message)" @@ -272,4 +272,4 @@ class FileUtils: choice = input("{} {} ".format(question, prompt)) or default # nosec return to_bool(choice) except (KeyboardInterrupt, ValueError) as e: - raise ansibledoctor.Exception.InputError("Error while reading input", e) + raise ansibledoctor.exception.InputError("Error while reading input", e) diff --git a/pyproject.toml b/pyproject.toml index 49e7a5a..831bdad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,7 +68,7 @@ pytest-mock = "^3.4.0" yapf = "^0.30.0" [tool.poetry.scripts] -ansible-doctor = "ansibledoctor.Cli:main" +ansible-doctor = "ansibledoctor.cli:main" [tool.poetry-dynamic-versioning] enable = true