From 8f8716b02f7401786229e6e37693419a7d4b7c21 Mon Sep 17 00:00:00 2001 From: Chris Laws Date: Sun, 2 May 2021 18:52:34 +0930 Subject: [PATCH] release prep --- .github/workflows/ci.yml | 51 +++ .pylintrc | 618 +++++++++++++++++++++++++++++++ Makefile | 20 +- README.rst | 10 +- requirements.dev.txt | 2 + setup.py | 3 +- src/dump1090exporter/__init__.py | 2 +- src/dump1090exporter/__main__.py | 22 +- src/dump1090exporter/exporter.py | 144 ++++--- src/dump1090exporter/metrics.py | 3 +- 10 files changed, 786 insertions(+), 89 deletions(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .pylintrc diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..791e172 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,51 @@ +name: Python Package Workflow + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.6, 3.7, 3.8, 3.9] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.dev.txt + pip install -r requirements.txt + - name: Cache pip dependencies + uses: actions/cache@v1 + with: + path: ~/.cache/pip # This path is specific to Ubuntu + # Check for a cache hit for the corresponding dev requirements file + key: ${{ runner.os }}-pip-${{ hashFiles('requirements.dev.txt') }}-${{ hashFiles('requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + ${{ runner.os }}- + - name: Check style + run: | + make check-style + - name: Check lint + run: | + make check-lint + - name: Check types + run: | + make check-types + - name: Check installation + run: | + pip install . + - name: Generate package + run: | + make dist diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..ee486f6 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,618 @@ +[MASTER] + +# 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= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# 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. +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 + +# 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 + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# 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 reenable 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=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape, + missing-module-docstring, + no-else-return, + too-many-instance-attributes, + invalid-name, + too-many-locals, + too-many-arguments, + logging-fstring-interpolation, + +# 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=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# 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=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, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[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 + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=new + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and 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 + + +[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= + + +[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 missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# 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 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 + +# List of module names for which member attributes should not be checked +# (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= + +# 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 + +# 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. Default to name +# with leading underscore. +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 + + +[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=100 + +# 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 + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# 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. +#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. +#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. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-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. +#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. +#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. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-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. +#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 + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[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 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# 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 + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# 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= + + +[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, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# 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=cls + + +[DESIGN] + +# 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 being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/Makefile b/Makefile index 6897492..7e888f3 100644 --- a/Makefile +++ b/Makefile @@ -41,27 +41,17 @@ scrub: git clean -x -f -d -# help: test - run tests -.PHONY: test -test: - @python -m unittest discover -s tests - - -# help: test-verbose - run tests [verbosely] -.PHONY: test-verbose -test-verbose: - @python -m unittest discover -s tests -v - - # help: check-style - perform code format compliance check .PHONY: check-style check-style: + @isort . --check-only --profile black @black --check src/dump1090exporter setup.py # help: style - perform code style formatting .PHONY: style style: + @isort . --profile black @black src/dump1090exporter setup.py @@ -71,6 +61,12 @@ check-types: @cd src; mypy -p dump1090exporter --ignore-missing-imports +# help: check-lint - run static analysis checks +.PHONY: check-lint +check-lint: + @pylint --rcfile=.pylintrc dump1090exporter setup.py + + # help: dist - create a wheel distribution package .PHONY: dist dist: diff --git a/README.rst b/README.rst index b9202ad..0f21f01 100644 --- a/README.rst +++ b/README.rst @@ -238,16 +238,12 @@ The following steps are used to make a new software release: $ source venv/bin/activate (d1090exp) $ -- Apply the code style formatter. - - .. code-block:: console - - (d1090exp) $ make style - -- Apply the code types checker. +- Perform checks (style, lint, types). .. code-block:: console + (d1090exp) $ make check-style + (d1090exp) $ make check-lint (d1090exp) $ make check-types - Create the distribution. This project produces an artefact called a pure diff --git a/requirements.dev.txt b/requirements.dev.txt index dd3fa45..811ff4e 100644 --- a/requirements.dev.txt +++ b/requirements.dev.txt @@ -1,3 +1,5 @@ black +isort mypy +pylint wheel diff --git a/setup.py b/setup.py index a9b785c..8caa192 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ def parse_requirements(filename): - """ Load requirements from a pip requirements file """ + """Load requirements from a pip requirements file""" with open(filename, "r") as fd: lines = [] for line in fd: @@ -60,6 +60,7 @@ def parse_requirements(filename): "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", "Topic :: System :: Monitoring", ], entry_points={ diff --git a/src/dump1090exporter/__init__.py b/src/dump1090exporter/__init__.py index 8856e40..2620d9b 100644 --- a/src/dump1090exporter/__init__.py +++ b/src/dump1090exporter/__init__.py @@ -1,3 +1,3 @@ from .exporter import Dump1090Exporter -__version__ = "20.1.0" +__version__ = "21.0.0" diff --git a/src/dump1090exporter/__main__.py b/src/dump1090exporter/__main__.py index 2fc5ed8..b5f086e 100644 --- a/src/dump1090exporter/__main__.py +++ b/src/dump1090exporter/__main__.py @@ -14,33 +14,33 @@ def main(): - """ Run the dump1090 Prometheus exporter """ + """Run the dump1090 Prometheus exporter""" - ARGS = argparse.ArgumentParser( + parser = argparse.ArgumentParser( prog="dump1090exporter", description="dump1090 Prometheus Exporter" ) - ARGS.add_argument( + parser.add_argument( "--resource-path", metavar="", type=str, default="http://localhost:8080", help="dump1090 URL or directory path of the dump1090 service", ) - ARGS.add_argument( + parser.add_argument( "--host", metavar="", type=str, default="0.0.0.0", help="The address to expose collected metrics from. Default is all interfaces.", ) - ARGS.add_argument( + parser.add_argument( "--port", metavar="", type=int, default=9105, help="The port to expose collected metrics from. Default is 9105", ) - ARGS.add_argument( + parser.add_argument( "--aircraft-interval", metavar="", type=int, @@ -48,7 +48,7 @@ def main(): default=10, help="The number of seconds between updates of the aircraft data. Default is 10 seconds", ) - ARGS.add_argument( + parser.add_argument( "--stats-interval", metavar="", type=int, @@ -56,25 +56,25 @@ def main(): default=60, help="The number of seconds between updates of the stats data. Default is 60 seconds", ) - ARGS.add_argument( + parser.add_argument( "--latitude", metavar="", type=float, default=None, help="The latitude of the receiver position to use as the origin.", ) - ARGS.add_argument( + parser.add_argument( "--longitude", metavar="", type=float, default=None, help="The longitude of the receiver position to use as the origin.", ) - ARGS.add_argument( + parser.add_argument( "--debug", action="store_true", default=False, help="Print debug output" ) - args = ARGS.parse_args() + args = parser.parse_args() if args.debug: logging.basicConfig(level=logging.DEBUG) diff --git a/src/dump1090exporter/exporter.py b/src/dump1090exporter/exporter.py index 202372c..272032d 100644 --- a/src/dump1090exporter/exporter.py +++ b/src/dump1090exporter/exporter.py @@ -10,9 +10,8 @@ import logging import math from asyncio.events import AbstractEventLoop -from math import asin, cos, radians, sin, sqrt, atan, degrees - -from typing import Any, Awaitable, Dict, Sequence, Tuple, Union +from math import asin, atan, cos, degrees, radians, sin, sqrt +from typing import Any, Dict, Sequence, Tuple, Union import aiohttp from aioprometheus import Gauge, Service @@ -56,7 +55,7 @@ def build_resources(base: str) -> Dump1090Resources: - """ Return a named tuple containing dump1090 resource paths """ + """Return a named tuple containing dump1090 resource paths""" resources = Dump1090Resources( base, f"{base}/receiver.json", @@ -65,9 +64,8 @@ def build_resources(base: str) -> Dump1090Resources: ) return resources -def relative_angle( - pos1: Position, pos2: Position -) -> float: + +def relative_angle(pos1: Position, pos2: Position) -> float: """ Calculate the direction pos2 relative to pos1. Returns angle in degrees @@ -77,57 +75,65 @@ def relative_angle( :returns: angle in degrees :rtype: float """ - lat1, lon1, lat2, lon2 = [x for x in (*pos1, *pos2)] + lat1, lon1, lat2, lon2 = [ + x for x in (*pos1, *pos2) # pylint: disable=unnecessary-comprehension + ] - """ - Special case - same lat as origin: 90 degs or 270 degs + # Special case - same lat as origin: 90 degrees or 270 degrees + # + # | + # -x-o-x- + # | - | - -x-o-x- - | - """ if lat2 == lat1: if lon2 > lon1: return 90 else: return 270 - deg = degrees(atan((lon2-lon1)/(lat2-lat1))) - - """ - Sign of results from the calculation above + deg = degrees(atan((lon2 - lon1) / (lat2 - lat1))) - - | + (lat2>lat1) - ---o--- - + | - (lat2lat1) + # ---o--- + # + | - (lat2 lat1: - return (360+deg) % 360 + return (360 + deg) % 360 else: - return 180+deg + return 180 + deg + # lookup table for directions - each step is 22.5 degrees direction_lut = ( "N", - "NE", "NE", - "E", "E", - "SE", "SE", - "S", "S", - "SW", "SW", - "W", "W", - "NW", "NW", - "N" + "NE", + "NE", + "E", + "E", + "SE", + "SE", + "S", + "S", + "SW", + "SW", + "W", + "W", + "NW", + "NW", + "N", ) -def relative_direction( - angle: float -) -> str: + +def relative_direction(angle: float) -> str: """ Convert relative angle in degrees into direction (N/NE/E/SE/S/SW/W/NW) """ - return direction_lut[int(angle/22.5)] + return direction_lut[int(angle / 22.5)] + def haversine_distance( pos1: Position, pos2: Position, radius: float = 6371.0e3 @@ -160,7 +166,7 @@ def haversine_distance( return distance -class Dump1090Exporter(object): +class Dump1090Exporter: """ This class is responsible for fetching, parsing and exporting dump1090 metrics to Prometheus. @@ -215,7 +221,9 @@ def __init__( self.host = host self.port = port self.receiver_interval = datetime.timedelta(seconds=receiver_interval) - self.receiver_interval_origin_ok = datetime.timedelta(seconds=receiver_interval_origin_ok) + self.receiver_interval_origin_ok = datetime.timedelta( + seconds=receiver_interval_origin_ok + ) self.aircraft_interval = datetime.timedelta(seconds=aircraft_interval) self.stats_interval = datetime.timedelta(seconds=stats_interval) self.stats_time_periods = time_periods @@ -233,7 +241,7 @@ def __init__( logger.info(f"Origin: {self.origin}") async def start(self) -> None: - """ Start the monitor """ + """Start the monitor""" await self.svr.start(addr=self.host, port=self.port) logger.info(f"serving dump1090 prometheus metrics on: {self.svr.metrics_url}") @@ -244,7 +252,7 @@ async def start(self) -> None: # fmt: on async def stop(self) -> None: - """ Stop the monitor """ + """Stop the monitor""" if self.receiver_task: self.receiver_task.cancel() @@ -307,7 +315,7 @@ async def _fetch( self, resource: str, ) -> Dict[Any, Any]: - """ Fetch JSON data from a web or file resource and return a dict """ + """Fetch JSON data from a web or file resource and return a dict""" logger.debug(f"fetching {resource}") if resource.startswith("http"): try: @@ -323,8 +331,8 @@ async def _fetch( except aiohttp.ClientError as exc: raise Exception(f"Client error {exc}, {resource}") from None else: - with open(resource, "rt") as f: - data = json.loads(f.read()) + with open(resource, "rt") as fd: + data = json.loads(fd.read()) return data @@ -344,13 +352,15 @@ async def updater_receiver(self) -> None: logger.info( f"Origin successfully extracted from receiver data: {self.origin}" ) - except Exception as exc: + except Exception as exc: # pylint: disable=broad-except logger.error(f"Error fetching dump1090 receiver data: {exc}") # wait until next collection time end = datetime.datetime.now() if self.origin: - wait_seconds = (start + self.receiver_interval_origin_ok - end).total_seconds() + wait_seconds = ( + start + self.receiver_interval_origin_ok - end + ).total_seconds() else: wait_seconds = (start + self.receiver_interval - end).total_seconds() await asyncio.sleep(wait_seconds) @@ -365,7 +375,7 @@ async def updater_stats(self) -> None: try: stats = await self._fetch(self.resources.stats) self.process_stats(stats, time_periods=self.stats_time_periods) - except Exception as exc: + except Exception as exc: # pylint: disable=broad-except logger.error(f"Error fetching dump1090 stats data: {exc}") # wait until next collection time @@ -383,7 +393,7 @@ async def updater_aircraft(self) -> None: try: aircraft = await self._fetch(self.resources.aircraft) self.process_aircraft(aircraft) - except Exception as exc: + except Exception as exc: # pylint: disable=broad-except logger.error(f"Error fetching dump1090 aircraft data: {exc}") # wait until next collection time @@ -451,10 +461,28 @@ def process_aircraft(self, aircraft: dict, threshold: int = 15) -> None: aircraft_with_pos = 0 aircraft_with_mlat = 0 aircraft_max_range = 0.0 - aircraft_direction = {"N": 0, "NE": 0, "E": 0, "SE": 0, "S": 0, "SW": 0, "W": 0, "NW": 0} - aircraft_direction_max_range = {"N": 0.0, "NE": 0.0, "E": 0.0, "SE": 0.0, "S": 0.0, "SW": 0.0, "W": 0.0, "NW": 0.0} + aircraft_direction = { + "N": 0, + "NE": 0, + "E": 0, + "SE": 0, + "S": 0, + "SW": 0, + "W": 0, + "NW": 0, + } + aircraft_direction_max_range = { + "N": 0.0, + "NE": 0.0, + "E": 0.0, + "SE": 0.0, + "S": 0.0, + "SW": 0.0, + "W": 0.0, + "NW": 0.0, + } # Filter aircraft to only those that have been seen within the - # last n seconds to minimise contributions from aged obsevations. + # last n seconds to minimise contributions from aged observations. for a in aircraft["aircraft"]: if a["seen"] < threshold: aircraft_observed += 1 @@ -467,7 +495,9 @@ def process_aircraft(self, aircraft: dict, threshold: int = 15) -> None: if distance > aircraft_max_range: aircraft_max_range = distance - a["rel_angle"] = relative_angle(self.origin, Position(a["lat"], a["lon"])) + a["rel_angle"] = relative_angle( + self.origin, Position(a["lat"], a["lon"]) + ) a["rel_direction"] = relative_direction(a["rel_angle"]) aircraft_direction[a["rel_direction"]] += 1 if distance > aircraft_direction_max_range[a["rel_direction"]]: @@ -485,10 +515,12 @@ def process_aircraft(self, aircraft: dict, threshold: int = 15) -> None: d["max_range"].set(labels, aircraft_max_range) d["messages_total"].set(labels, messages) - for dir in aircraft_direction: - labels = dict(time_period="latest", direction=dir) - d["observed_with_direction"].set(labels, aircraft_direction[dir]) - d["max_range_by_direction"].set(labels, aircraft_direction_max_range[dir]) + for direction in aircraft_direction: + labels = dict(time_period="latest", direction=direction) + d["observed_with_direction"].set(labels, aircraft_direction[direction]) + d["max_range_by_direction"].set( + labels, aircraft_direction_max_range[direction] + ) logger.debug( f"aircraft: observed={aircraft_observed}, " diff --git a/src/dump1090exporter/metrics.py b/src/dump1090exporter/metrics.py index b363dcf..7fa438b 100644 --- a/src/dump1090exporter/metrics.py +++ b/src/dump1090exporter/metrics.py @@ -58,7 +58,8 @@ "recent_aircraft_with_position", "Number of aircraft recently observed with position", ), - ( "observed_with_direction", + ( + "observed_with_direction", "recent_aircraft_with_direction", "Number of aircraft recently observed with direction relative to receiver", ),