From 2ca72b25712193b3e21e01983a1535e18db48bb8 Mon Sep 17 00:00:00 2001 From: Nathan Lourie Date: Wed, 11 Sep 2024 09:33:38 -0400 Subject: [PATCH 1/2] fixing pylint unhappiness --- .pylintrc | 649 ++++++++++++++++++++++++- README.md | 8 + src/image_daemon/utils/winter_image.py | 190 +++----- 3 files changed, 731 insertions(+), 116 deletions(-) diff --git a/.pylintrc b/.pylintrc index 01dad4b..6dbb381 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,5 +1,648 @@ -[MASTER] -ignore=venv,docs +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS, docs, venv + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked and +# will not be imported (useful for modules/projects where namespaces are +# manipulated during runtime and thus existing member attributes cannot be +# deduced by static analysis). It supports qualified module names, as well as +# Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Resolve imports to .pyi stubs if available. May reduce no-member messages and +# increase not-an-iterable messages. +prefer-stubs=no + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.12 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=120 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + [MESSAGES CONTROL] -disable=C0114,C0115,C0116 + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero, + too-many-arguments, + too-many-attributes, + too-many-local-variables, + too-many-branches, + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/README.md b/README.md index cdaa56d..33c75fe 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,11 @@ this project uses poetry to manage the packages. Set it up this way: conda install poetry -c conda-forge` poetry install ``` + +After this is set up, install the library in your new conda environment. From inside the `image-daemon` directory: + +```shell +python -m pip install -e . +``` + +where `-e` keeps the installed version up to date if you make edits to the code within the repository. diff --git a/src/image_daemon/utils/winter_image.py b/src/image_daemon/utils/winter_image.py index e618fa8..485188b 100644 --- a/src/image_daemon/utils/winter_image.py +++ b/src/image_daemon/utils/winter_image.py @@ -36,22 +36,14 @@ class WinterImage: A class to handle the WINTER camera data and headers. Attributes: - filepath (str): The path of the image file. - filename (str): The name of the image file. - comment (str): Additional comments about the image. - logger (Optional[logging.Logger]): Logger for logging messages. - verbose (bool): Flag to control verbosity of logs. - imgs (Dict[str, np.ndarray]): Dictionary holding sub-images keyed by address. - headers (List[Any]): List of headers for each sub-image. - header (fits.Header): Top-level FITS header. - _mef_addr_order (List[str]): Order of MEF addresses. - _board_id_order (List[int]): Order of board IDs. - _layer_by_addr (Dict[str, int]): Mapping from address to layer index. - _layer_by_board_id (Dict[int, int]): Mapping from board ID to layer index. - _board_id_by_addr (Dict[str, int]): Mapping from address to board ID. - _addr_by_board_id (Dict[int, str]): Mapping from board ID to address. - _rowcol_locs (List[tuple[int, int]]): Row and column locations for subplots. - _rowcol_locs_by_addr (Dict[str, tuple[int, int]]): Mapping from address to subplot locations. + filepath: Path to the image file. + filename: Name of the image file. + comment: Additional comments about the image. + logger: Logger instance for logging messages. + verbose: Flag to control verbosity of logs. + imgs: Dictionary holding sub-images keyed by address. + headers: List of headers for each sub-image. + header: Top-level FITS header. """ def __init__( @@ -65,15 +57,13 @@ def __init__( """ Initializes the WinterImage object and loads the image or data. - Args: - data (Union[str, np.ndarray]): File path to a FITS file or a numpy array of image data. - headers (Optional[Dict[str, Any]], optional): Dictionary of headers corresponding to the image layers. Defaults to None. - comment (str, optional): Additional comments about the image. Defaults to "". - logger (Optional[logging.Logger], optional): Logger instance for logging. Defaults to None. - verbose (bool, optional): If True, enables verbose logging. Defaults to False. + :param data: File path to a FITS file or a numpy array of image data. + :param headers: Dictionary of headers corresponding to the image layers. Defaults to None. + :param comment: Additional comments about the image. Defaults to an empty string. + :param logger: Logger instance for logging. Defaults to None. + :param verbose: Enables verbose logging if True. Defaults to False. - Raises: - ValueError: If the input data format is not a string or a numpy array. + :raises ValueError: If the input data format is invalid. """ self.filepath: str = "" self.filename: str = "" @@ -120,11 +110,10 @@ def __init__( def load_image(self, mef_file_path: str, comment: str = "") -> None: """ - Loads the data from a MEF FITS file as a numpy array. + Loads the data from a MEF FITS file into a numpy array. - Args: - mef_file_path (str): The file path to the MEF FITS file. - comment (str, optional): Additional comments about the image. Defaults to "". + :param mef_file_path: The file path to the MEF FITS file. + :param comment: Additional comments about the image. Defaults to an empty string. """ self.filepath = mef_file_path self.filename = os.path.basename(self.filepath) @@ -133,35 +122,28 @@ def load_image(self, mef_file_path: str, comment: str = "") -> None: self.headers = [] with fits.open(self.filepath) as hdu: - self.header = hdu[0].header - for ext in hdu[1:]: - datasec_str: str = ext.header["DATASEC"][1:-1] - datasec: np.ndarray = np.array(re.split(r"[,:]", datasec_str)).astype( - int - ) - data: np.ndarray = ext.data[ - datasec[2] : datasec[3], datasec[0] : datasec[1] - ] + datasec_str = ext.header["DATASEC"][1:-1] + datasec = np.array(re.split(r"[,:]", datasec_str)).astype(int) + data = ext.data[datasec[2] : datasec[3], datasec[0] : datasec[1]] - addr: Optional[str] = ext.header.get("ADDR", None) + addr = ext.header.get("ADDR", None) if addr in self._mef_addr_order: self.imgs[addr] = data else: - boardid: Optional[int] = ext.header.get("BOARD_ID", None) + boardid = ext.header.get("BOARD_ID", None) if boardid in self._board_id_order: - addr_mapped: str = self._addr_by_board_id[boardid] + addr_mapped = self._addr_by_board_id[boardid] self.imgs[addr_mapped] = data def log(self, msg: str, level: int = logging.INFO) -> None: """ Logs a message with the specified logging level. - Args: - msg (str): The message to log. - level (int, optional): The logging level. Defaults to logging.INFO. + :param msg: The message to log. + :param level: The logging level (e.g., logging.INFO). Defaults to logging.INFO. """ - formatted_msg: str = f"WinterImage {msg}" + formatted_msg = f"WinterImage {msg}" if self.logger is None: print(formatted_msg) @@ -176,9 +158,8 @@ def load_data( """ Loads image data from a dictionary of images. - Args: - imgs_dict (Dict[str, np.ndarray]): Dictionary of images keyed by address. - headers_dict (Optional[Dict[str, Any]], optional): Dictionary of headers for each image. Defaults to None. + :param imgs_dict: Dictionary of images keyed by address. + :param headers_dict: Dictionary of headers for each image. Defaults to None. """ self.imgs = imgs_dict if headers_dict is None: @@ -194,43 +175,40 @@ def plot_mosaic( norm_by: str = "full", post_to_slack: bool = False, # pylint: disable=unused-argument savepath: Optional[str] = None, - *args: Any, + *args: Any, # pylint: disable=keyword-arg-before-vararg **kwargs: Any, ) -> None: """ - Plots a mosaic of sub-images with optional color bar and color map. - - Args: - title (Optional[str], optional): Title of the plot. Defaults to None. - cbar (bool, optional): Whether to add a color bar. Defaults to False. - cmap (Union[str, Dict[str, str]], optional): Colormap or a dictionary of colormaps by address. Defaults to "gray". - norm_by (str, optional): Normalization method ("full", "sensor", or "chan"). Defaults to "full". - post_to_slack (bool, optional): Not used, but passed as an argument. Defaults to False. - savepath (Optional[str], optional): Path to save the plotted mosaic. Defaults to None. - *args (Any): Additional positional arguments passed to `imshow`. - **kwargs (Any): Additional keyword arguments passed to `imshow`. + Plots a mosaic of sub-images with an optional color bar and color map. + + :param title: The title of the plot. Defaults to None. + :param cbar: Whether to add a color bar. Defaults to False. + :param cmap: Colormap or a dictionary of colormaps by address. Defaults to "gray". + :param norm_by: Normalization method ("full", "sensor", or "chan"). Defaults to "full". + :param post_to_slack: Unused argument. Defaults to False. + :param savepath: Path to save the plotted mosaic. Defaults to None. + :param args: Additional positional arguments passed to `imshow`. + :param kwargs: Additional keyword arguments passed to `imshow`. """ - aspect_ratio: float = 1920 / 1080 - w: float = 3 - h: float = w / aspect_ratio + aspect_ratio = 1920 / 1080 + w = 3 + h = w / aspect_ratio fig, axarr = plt.subplots(3, 2, figsize=(4 * h, 2.0 * w)) # Combine all the data to figure out the full-image normalization - alldata: np.ndarray = np.concatenate( - [img.flatten() for img in self.imgs.values()] - ) + alldata = np.concatenate([img.flatten() for img in self.imgs.values()]) for addr in self._mef_addr_order: if addr in self.imgs: - image: np.ndarray = self.imgs[addr] + image = self.imgs[addr] # Rotate starboard images by 180 degrees if addr.startswith("s"): image = np.rot90(image, 2) else: image = np.zeros((1081, 1921)) - rowcol: tuple[int, int] = self._rowcol_locs_by_addr[addr] + rowcol = self._rowcol_locs_by_addr[addr] row, col = rowcol if norm_by.lower() == "full": @@ -248,7 +226,7 @@ def plot_mosaic( ax0 = axarr[row, col] if isinstance(cmap, str): - current_cmap: str = cmap + current_cmap = cmap elif isinstance(cmap, dict): current_cmap = cmap.get(addr, "gray") else: @@ -291,18 +269,14 @@ def get_img(self, chan: Union[str, int], index_by: str = "addr") -> np.ndarray: """ Retrieves a sub-image based on the specified channel and indexing method. - Args: - chan (Union[str, int]): The channel identifier, either by address (str) or board ID (int). - index_by (str, optional): How to index the channel, either by 'addr', 'board_id', or 'layer'. Defaults to "addr". - - Raises: - ValueError: If the indexing scheme is not one of 'addr', 'board_id', or 'layer'. - KeyError: If the specified channel does not exist. - - Returns: - np.ndarray: The requested sub-image. + :param chan: The channel identifier, either by address (str) or board ID (int). + :param index_by: How to index the channel, either by 'addr', 'board_id', or 'layer'. + Defaults to "addr". + :return: The requested sub-image. + :raises ValueError: If the indexing scheme is not one of 'addr', 'board_id', or 'layer'. + :raises KeyError: If the specified channel does not exist. """ - index_by_lower: str = index_by.lower() + index_by_lower = index_by.lower() addr: Optional[str] = None if index_by_lower in ["name", "addr"]: @@ -334,9 +308,9 @@ def get_img(self, chan: Union[str, int], index_by: str = "addr") -> np.ndarray: ) try: - img: np.ndarray = self.imgs[addr] - except KeyError: - raise KeyError(f"Image for address '{addr}' not found.") + img = self.imgs[addr] + except KeyError as e: + raise KeyError(f"Image for address '{addr}' not found.") from e return img @@ -352,22 +326,20 @@ def validate_image( """ Compares the specified MEF FITS image to a template and determines the health of each sensor. - Args: - mef_file_path (str): Path to the MEF FITS file to validate. - template_path (str): Path to the template MEF FITS file. - addrs (Optional[List[str]], optional): List of addresses to validate. If None, all addresses in the test data are validated. Defaults to None. - comment (str, optional): Additional comments to include in the plot title. Defaults to "". - plot (bool, optional): Whether to generate and display a plot of the validation results. Defaults to True. - savepath (Optional[str], optional): Path to save the plotted validation results. If None, the plot is not saved. Defaults to None. - - Returns: - Dict[str, Any]: Dictionary containing validation results, including: - - Each address with a sub-dictionary containing: - - "okay" (bool): Whether the sensor is in a good state. - - "mean" (float): Mean of the deviation from the template. - - "std" (float): Standard deviation of the deviation from the template. - - "bad_chans" (List[str]): List of addresses with problematic sensors. - - "good_chans" (List[str]): List of addresses with well-behaved sensors. + :param mef_file_path: Path to the MEF FITS file to validate. + :param template_path: Path to the template MEF FITS file. + :param addrs: List of addresses to validate. If None, all addresses in the test data are validated. + Defaults to None. + :param comment: Additional comments to include in the plot title. Defaults to an empty string. + :param plot: Whether to generate and display a plot of the validation results. Defaults to True. + :param savepath: Path to save the plotted validation results. If None, the plot is not saved. Defaults to None. + :return: Dictionary containing validation results, including: + - Each address with a sub-dictionary containing: + - "okay" (bool): Whether the sensor is in a good state. + - "mean" (float): Mean of the deviation from the template. + - "std" (float): Standard deviation of the deviation from the template. + - "bad_chans" (List[str]): List of addresses with problematic sensors. + - "good_chans" (List[str]): List of addresses with well-behaved sensors. """ results: Dict[str, Any] = {} cmaps: Dict[str, str] = {} @@ -379,7 +351,7 @@ def validate_image( template_data = WinterImage(data=template_path) # Retrieve all addresses from the test data - all_addrs: List[str] = list(test_data.imgs.keys()) + all_addrs = list(test_data.imgs.keys()) if addrs is None: addrs = all_addrs @@ -411,12 +383,12 @@ def validate_image( ratio[~np.isfinite(ratio)] = 0 # Set inf and NaN to 0 data = np.abs(1 - ratio) - std: float = np.std(data) - mean: float = np.mean(data) + std = np.std(data) + mean = np.mean(data) if (std > 0.5) or (mean > 0.1): # Image is likely bad - okay: bool = False + okay = False cmaps[addr] = "Reds" bad_chans.append(addr) else: @@ -455,23 +427,15 @@ def validate_image( if __name__ == "__main__": # Template image - template_path = os.path.join(data_dir, "test", "master_bias.fits") - template_im = WinterImage(data=template_path) + template_data_path = os.path.join(data_dir, "test", "master_bias.fits") + template_im = WinterImage(data=template_data_path) template_im.plot_mosaic() - # # Partial image (commented out) - # imgpath = os.path.join(topdir, 'data', 'test', 'test_pa_pb_pc_mef.fits') - # im = WinterImage(data=imgpath) - # # im.plot_mosaic() - # result = validate_image(imgpath, template_path, plot=True) - # print(result) - # Full image imgpath = os.path.join(data_dir, "test", "test_full_mef.fits") im = WinterImage(data=imgpath) - # im.plot_mosaic() result = validate_image( - mef_file_path=imgpath, template_path=template_path, plot=True + mef_file_path=imgpath, template_path=template_data_path, plot=True ) print(f"bad chans: {result['bad_chans']}") print(f"good chans: {result['good_chans']}") From 7c0a929d872b53bdb61714467f967f8b21f9c8ba Mon Sep 17 00:00:00 2001 From: Nathan Lourie Date: Wed, 11 Sep 2024 09:36:46 -0400 Subject: [PATCH 2/2] got rid of *args and tuning up pylint still --- .pylintrc | 4 ++-- src/image_daemon/utils/winter_image.py | 4 +--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.pylintrc b/.pylintrc index 6dbb381..ce749a1 100644 --- a/.pylintrc +++ b/.pylintrc @@ -437,9 +437,9 @@ disable=raw-checker-failed, use-implicit-booleaness-not-comparison-to-string, use-implicit-booleaness-not-comparison-to-zero, too-many-arguments, - too-many-attributes, - too-many-local-variables, + too-many-locals, too-many-branches, + too-many-instance-attributes, # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/src/image_daemon/utils/winter_image.py b/src/image_daemon/utils/winter_image.py index 485188b..21a7186 100644 --- a/src/image_daemon/utils/winter_image.py +++ b/src/image_daemon/utils/winter_image.py @@ -175,7 +175,6 @@ def plot_mosaic( norm_by: str = "full", post_to_slack: bool = False, # pylint: disable=unused-argument savepath: Optional[str] = None, - *args: Any, # pylint: disable=keyword-arg-before-vararg **kwargs: Any, ) -> None: """ @@ -187,7 +186,6 @@ def plot_mosaic( :param norm_by: Normalization method ("full", "sensor", or "chan"). Defaults to "full". :param post_to_slack: Unused argument. Defaults to False. :param savepath: Path to save the plotted mosaic. Defaults to None. - :param args: Additional positional arguments passed to `imshow`. :param kwargs: Additional keyword arguments passed to `imshow`. """ aspect_ratio = 1920 / 1080 @@ -243,7 +241,7 @@ def plot_mosaic( ) individual_plot = ax0.imshow( - image, origin="lower", cmap=current_cmap, norm=norm, *args, **kwargs + image, origin="lower", cmap=current_cmap, norm=norm, **kwargs ) ax0.set_xlabel("X [pixels]") ax0.set_ylabel("Y [pixels]")