diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..3585c5a --- /dev/null +++ b/.pylintrc @@ -0,0 +1,582 @@ +[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-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS,test + +# Add files or directories matching the regex patterns to the blacklist. 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 + +# Specify a configuration file. +#rcfile= + +# 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, + +# 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 + + +[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 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 + + +[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 + + +[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= + + +[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 + +# 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 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, + _ + +# 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 the implicit-str-concat-in-sequence should +# generate a warning on implicit string concatenation in sequences defined over +# several lines. +check-str-concat-over-line-jumps=no + + +[LOGGING] + +# Format style used to check logging format string. `old` means using % +# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[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 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=120 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# 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 + + +[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 + + +[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 + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in 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] + +# 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 + + +[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 13a968e..059ab77 100644 --- a/Makefile +++ b/Makefile @@ -12,6 +12,8 @@ test: ## Run tests @pytest @flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude venv @flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --exclude venv + @pylint fmi_weather_client + @pylint fmi_weather_client/parsers clean: ## Clean build and dist directories @rm -rf ./build ./dist ./fmi_weather_client.egg-info diff --git a/example.py b/example.py index 21c5e77..556e43b 100644 --- a/example.py +++ b/example.py @@ -2,10 +2,10 @@ from fmi_weather_client.models import Forecast, Weather, WeatherData -def print_weather(observation: Weather): - print(observation.place) - print("Location: %s, %s" % (observation.lat, observation.lon)) - print_weather_data(observation.data) +def print_weather(weather: Weather): + print(weather.place) + print("Location: %s, %s" % (weather.lat, weather.lon)) + print_weather_data(weather.data) print(" ") @@ -18,11 +18,11 @@ def print_forecast(station_forecast: Forecast): def print_weather_data(weather: WeatherData): - print(" Timestamp: %s" % weather.time) - print(" Temperature: %s" % weather.temperature) - print(" Humidity: %s" % weather.humidity) - print(" Wind speed: %s" % weather.wind_speed) - print(" Cloud cover: %s" % weather.cloud_cover) + print(f" Timestamp: {weather.time}") + print(f" Temperature: {weather.temperature}") + print(f" Humidity: {weather.humidity}") + print(f" Wind speed: {weather.wind_speed}") + print(f" Cloud cover: {weather.cloud_cover}") weather1 = fmi_weather_client.weather_by_coordinates(60.170998, 24.941325) diff --git a/fmi_weather_client/__init__.py b/fmi_weather_client/__init__.py index 944b3ca..162eeef 100644 --- a/fmi_weather_client/__init__.py +++ b/fmi_weather_client/__init__.py @@ -28,10 +28,7 @@ async def async_weather_by_coordinates(lat: float, lon: float) -> Weather: :return: Latest weather information """ loop = asyncio.get_event_loop() - response = await loop.run_in_executor(None, http.request_weather_by_coordinates, lat, lon) - forecast = forecast_parser.parse_forecast(response) - weather_state = forecast.forecasts[-1] - return Weather(forecast.place, forecast.lat, forecast.lon, weather_state) + return await loop.run_in_executor(None, weather_by_coordinates, lat, lon) def weather_by_place_name(name: str) -> Weather: @@ -55,10 +52,7 @@ async def async_weather_by_place_name(name: str) -> Weather: :return: Latest weather information """ loop = asyncio.get_event_loop() - response = await loop.run_in_executor(None, http.request_weather_by_place, name) - forecast = forecast_parser.parse_forecast(response) - weather_state = forecast.forecasts[-1] - return Weather(forecast.place, forecast.lat, forecast.lon, weather_state) + return await loop.run_in_executor(None, weather_by_place_name, name) def forecast_by_place_name(name: str, timestep_hours: int = 24): @@ -80,8 +74,7 @@ async def async_forecast_by_place_name(name: str, timestep_hours: int = 24): :return: Latest forecast """ loop = asyncio.get_event_loop() - response = await loop.run_in_executor(None, http.request_forecast_by_place, name, timestep_hours) - return forecast_parser.parse_forecast(response) + return await loop.run_in_executor(None, forecast_by_place_name, name, timestep_hours) def forecast_by_coordinates(lat: float, lon: float, timestep_hours: int = 24): @@ -105,5 +98,4 @@ async def async_forecast_by_coordinates(lat: float, lon: float, timestep_hours: :return: Latest forecast """ loop = asyncio.get_event_loop() - response = await loop.run_in_executor(None, http.request_forecast_by_coordinates, lat, lon, timestep_hours) - return forecast_parser.parse_forecast(response) + return await loop.run_in_executor(None, forecast_by_coordinates, lat, lon, timestep_hours) diff --git a/fmi_weather_client/errors.py b/fmi_weather_client/errors.py index fbdda50..e057886 100644 --- a/fmi_weather_client/errors.py +++ b/fmi_weather_client/errors.py @@ -1,6 +1,6 @@ class NoDataAvailableError(Exception): - pass + """Represents data not available error""" class ServiceError(Exception): - pass + """Represents unknown FMI service error""" diff --git a/fmi_weather_client/http.py b/fmi_weather_client/http.py index bdf0861..8be2daa 100644 --- a/fmi_weather_client/http.py +++ b/fmi_weather_client/http.py @@ -1,5 +1,6 @@ import logging from datetime import datetime, timedelta, timezone +from enum import Enum from typing import Any, Dict, Optional import requests @@ -9,6 +10,12 @@ _LOGGER = logging.getLogger(__name__) +class RequestType(Enum): + """Possible request types""" + WEATHER = 0 + FORECAST = 1 + + def request_weather_by_coordinates(lat: float, lon: float) -> str: """ Get the latest weather information by coordinates. @@ -17,9 +24,7 @@ def request_weather_by_coordinates(lat: float, lon: float) -> str: :param lon: Longitude (e.g. 62.39758) :return: Latest weather information """ - end_time = datetime.utcnow().replace(tzinfo=timezone.utc) - start_time = end_time - timedelta(minutes=10) - params = _create_params(start_time, end_time, 10, lat=lat, lon=lon) + params = _create_params(RequestType.WEATHER, 10, lat=lat, lon=lon) return _send_request(params) @@ -30,9 +35,7 @@ def request_weather_by_place(place: str) -> str: :param place: Place name (e.g. Kaisaniemi, Helsinki) :return: Latest weather information """ - end_time = datetime.utcnow().replace(tzinfo=timezone.utc) - start_time = end_time - timedelta(minutes=10) - params = _create_params(start_time, end_time, 10, place=place) + params = _create_params(RequestType.WEATHER, 10, place=place) return _send_request(params) @@ -45,10 +48,8 @@ def request_forecast_by_coordinates(lat: float, lon: float, timestep_hours: int :param timestep_hours: Forecast steps in hours :return: Forecast response """ - start_time = datetime.utcnow().replace(tzinfo=timezone.utc) - end_time = start_time + timedelta(days=4) - timestep = timestep_hours * 60 - params = _create_params(start_time, end_time, timestep, lat=lat, lon=lon) + timestep_minutes = timestep_hours * 60 + params = _create_params(RequestType.FORECAST, timestep_minutes, lat=lat, lon=lon) return _send_request(params) @@ -60,23 +61,18 @@ def request_forecast_by_place(place: str, timestep_hours: int = 24) -> str: :param timestep_hours: Forecast steps in hours :return: Forecast response """ - start_time = datetime.utcnow().replace(tzinfo=timezone.utc) - end_time = start_time + timedelta(days=4) - timestep = timestep_hours * 60 - params = _create_params(start_time, end_time, timestep, place=place) + timestep_minutes = timestep_hours * 60 + params = _create_params(RequestType.FORECAST, timestep_minutes, place=place) return _send_request(params) -def _create_params(start_time: datetime, - end_time: datetime, +def _create_params(request_type: RequestType, timestep_minutes: int, place: Optional[str] = None, lat: Optional[float] = None, lon: Optional[float] = None) -> Dict[str, Any]: """ Create query parameters - :param start_time: Start datetime - :param end_time: End datetime :param timestep_minutes: Timestamp minutes :param place: Place name :param lat: Latitude @@ -87,6 +83,15 @@ def _create_params(start_time: datetime, if place is None and lat is None and lon is None: raise Exception("Missing location parameter") + if request_type is RequestType.WEATHER: + end_time = datetime.utcnow().replace(tzinfo=timezone.utc) + start_time = end_time - timedelta(minutes=10) + elif request_type is RequestType.FORECAST: + start_time = datetime.utcnow().replace(tzinfo=timezone.utc) + end_time = start_time + timedelta(days=4) + else: + raise Exception(f"Invalid request_type {request_type}") + params = { 'service': 'WFS', 'version': '2.0.0', @@ -114,11 +119,11 @@ def _send_request(params: Dict[str, Any]) -> str: """ url = 'http://opendata.fmi.fi/wfs' - _LOGGER.debug(f"Sending GET to {url} with parameters: {params}") + _LOGGER.debug("Sending GET to %s with parameters: %s", url, params) response = requests.get(url, params=params) if response.status_code >= 500: raise ServiceError("Invalid FMI service response", {'status_code': response.status_code, 'body': response.text}) - _LOGGER.debug(f"Received a response from FMI in {response.elapsed.microseconds / 1000} ms", ) + _LOGGER.debug("Received a response from FMI in %s ms", response.elapsed.microseconds / 1000) return response.text diff --git a/fmi_weather_client/models.py b/fmi_weather_client/models.py index a734289..e664b1f 100644 --- a/fmi_weather_client/models.py +++ b/fmi_weather_client/models.py @@ -1,91 +1,78 @@ from datetime import datetime -from typing import Dict, List, Optional +from typing import List, Optional, NamedTuple -class FMIPlace: - def __init__(self, name: str, lat: float, lon: float): - self.name: str = name - self.lat: float = lat - self.lon: float = lon +class FMIPlace(NamedTuple): + """Represent a place in FMI response""" + name: str + lat: float + lon: float def __str__(self): return f"{self.name} ({self.lat}, {self.lon})" -class Value: - def __init__(self, value: Optional[float], unit: str): - self.value: Optional[float] = value - self.unit: str = unit +class Value(NamedTuple): + """Represents a weather value""" + value: Optional[float] + unit: str def __str__(self): return f"{self.value} {self.unit}" -class WeatherData: - def __init__(self, timestamp: datetime, values: Dict[str, float]): - - def to_value(o: Dict[str, float], variable_name: str, unit: str) -> Value: - value = o.get(variable_name, None) - return Value(value, unit) - - self.time: datetime = timestamp - - self.temperature: Value = to_value(values, 'Temperature', '°C') - self.dew_point: Value = to_value(values, 'DewPoint', '°C') - - self.pressure: Value = to_value(values, 'Pressure', 'hPa') - self.humidity: Value = to_value(values, 'Humidity', '%') - - self.wind_direction: Value = to_value(values, 'WindDirection', '°') - self.wind_speed: Value = to_value(values, 'WindSpeedMS', 'm/s') - self.wind_u_component: Value = to_value(values, 'WindUMS', 'm/s') - self.wind_v_component: Value = to_value(values, 'WindVMS', 'm/s') - self.wind_max: Value = to_value(values, 'MaximumWind', 'm/s') # Max 10 min average - self.wind_gust: Value = to_value(values, 'WindGust', 'm/s') # Max 3 sec average - - self.symbol: Value = to_value(values, 'WeatherSymbol3', '') - self.cloud_cover: Value = to_value(values, 'TotalCloudCover', '%') - - self.cloud_low_cover: Value = to_value(values, 'LowCloudCover', '%') - self.cloud_mid_cover: Value = to_value(values, 'MediumCloudCover', '%') - self.cloud_high_cover: Value = to_value(values, 'HighCloudCover', '%') - - # Amount of rain in the past 1h - self.precipitation_amount: Value = to_value(values, 'Precipitation1h', 'mm/h') - - # No idea what this is since it is missing the time - # self.precipitation_amount: Value = to_value(values, 'PrecipitationAmount', 'mm') - - # Short wave radiation (light, UV) accumulation - self.radiation_short_wave_acc: Value = to_value(values, 'RadiationGlobalAccumulation', 'J/m²') - - # Short wave radiation (light, UV) net accumulation on the surface - self.radiation_short_wave_surface_net_acc: Value = to_value(values, 'RadiationNetSurfaceSWAccumulation', 'J/m²') - - # Long wave radiation (heat, infrared) accumulation - self.radiation_long_wave_acc: Value = to_value(values, 'RadiationLWAccumulation', 'J/m²') - - # Long wave radiation (light, UV) net accumulation on the surface - self.radiation_long_wave_surface_net_acc: Value = to_value(values, 'RadiationNetSurfaceLWAccumulation', 'J/m²') - - # Diffused short wave - self.radiation_short_wave_diff_surface_acc: Value = to_value(values, 'RadiationDiffuseAccumulation', 'J/m²') - - self.geopotential_height: Value = to_value(values, 'GeopHeight', 'm') - self.land_sea_mask: Value = to_value(values, 'LandSeaMask', '') - - -class Weather: - def __init__(self, place: str, lat: float, lon: float, weather_data: WeatherData): - self.place: str = place - self.lat: float = lat - self.lon: float = lon - self.data: WeatherData = weather_data - - -class Forecast: - def __init__(self, place: str, lat: float, lon: float, forecasts: List[WeatherData]): - self.place: str = place - self.lat: float = lat - self.lon: float = lon - self.forecasts: List[WeatherData] = forecasts +class WeatherData(NamedTuple): + """Represents a weather""" + time: datetime + temperature: Value + dew_point: Value + pressure: Value + humidity: Value + wind_direction: Value + wind_speed: Value + wind_u_component: Value + wind_v_component: Value + wind_max: Value # Max 10 minutes average + wind_gust: Value # Max 3 seconds average + symbol: Value + cloud_cover: Value + cloud_low_cover: Value + cloud_mid_cover: Value + cloud_high_cover: Value + + # Amount of rain in the past 1h + precipitation_amount: Value + + # Short wave radiation (light, UV) accumulation + radiation_short_wave_acc: Value + + # Short wave radiation (light, UV) net accumulation on the surface + radiation_short_wave_surface_net_acc: Value + + # Long wave radiation (heat, infrared) accumulation + radiation_long_wave_acc: Value + + # Long wave radiation (light, UV) net accumulation on the surface + radiation_long_wave_surface_net_acc: Value + + # Diffused short wave + radiation_short_wave_diff_surface_acc: Value + + geopotential_height: Value + land_sea_mask: Value + + +class Weather(NamedTuple): + """Represents a weather""" + place: str + lat: float + lon: float + data: WeatherData + + +class Forecast(NamedTuple): + """Represents a forecast""" + place: str + lat: float + lon: float + forecasts: List[WeatherData] diff --git a/fmi_weather_client/parsers/forecast.py b/fmi_weather_client/parsers/forecast.py index 59e88d9..e6ed7fd 100644 --- a/fmi_weather_client/parsers/forecast.py +++ b/fmi_weather_client/parsers/forecast.py @@ -1,11 +1,14 @@ +# pylint: disable=bad-continuation +# Just because I like to align them like this ;) +import math from datetime import datetime, timezone -from typing import Any, Dict, List +from typing import Any, Dict, List, Optional import xmltodict -from fmi_weather_client import errors, utils +from fmi_weather_client import errors from fmi_weather_client.errors import NoDataAvailableError -from fmi_weather_client.models import FMIPlace, Forecast, WeatherData +from fmi_weather_client.models import FMIPlace, Forecast, WeatherData, Value def parse_forecast(body: str): @@ -33,8 +36,8 @@ def parse_forecast(body: str): # Combine typed values with times for idx, time in enumerate(times): - if utils.is_non_empty_forecast(typed_value_sets[idx]): - forecast.forecasts.append(WeatherData(time, typed_value_sets[idx])) + if _is_non_empty_forecast(typed_value_sets[idx]): + forecast.forecasts.append(_create_weather_data(time, typed_value_sets[idx])) return forecast @@ -51,7 +54,7 @@ def _body_to_dict(body: str) -> Dict[str, Any]: if 'ExceptionReport' in data.keys(): if 'No locations found for the place' in data['ExceptionReport']['Exception']['ExceptionText'][0]: raise errors.NoDataAvailableError - elif 'No data available for' in data['ExceptionReport']['Exception']['ExceptionText'][0]: + if 'No data available for' in data['ExceptionReport']['Exception']['ExceptionText'][0]: raise errors.NoDataAvailableError raise errors.ServiceError(data['ExceptionReport']['Exception']['ExceptionText'][0]) @@ -111,7 +114,7 @@ def _get_values(data: Dict[str, Any]) -> List[List[float]]: value_set = [] for value in forecast_values: value_set.append(float(value)) - if not contains_values and utils.float_or_none(value) is not None: + if not contains_values and _float_or_none(value) is not None: contains_values = True result.append(value_set) @@ -120,3 +123,65 @@ def _get_values(data: Dict[str, Any]) -> List[List[float]]: raise NoDataAvailableError return result + + +def _create_weather_data(time, values: Dict[str, float]) -> WeatherData: + """Create weather data from raw values""" + + def to_value(vals: Dict[str, float], variable_name: str, unit: str) -> Value: + value = vals.get(variable_name, None) + return Value(value, unit) + + return WeatherData( + time=time, + temperature=to_value(values, 'Temperature', '°C'), + dew_point=to_value(values, 'DewPoint', '°C'), + pressure=to_value(values, 'Pressure', 'hPa'), + humidity=to_value(values, 'Humidity', '%'), + wind_direction=to_value(values, 'WindDirection', '°'), + wind_speed=to_value(values, 'WindSpeedMS', 'm/s'), + wind_u_component=to_value(values, 'WindUMS', 'm/s'), + wind_v_component=to_value(values, 'WindVMS', 'm/s'), + wind_max=to_value(values, 'MaximumWind', 'm/s'), + wind_gust=to_value(values, 'WindGust', 'm/s'), + symbol=to_value(values, 'WeatherSymbol3', ''), + cloud_cover=to_value(values, 'TotalCloudCover', '%'), + cloud_low_cover=to_value(values, 'LowCloudCover', '%'), + cloud_mid_cover=to_value(values, 'MediumCloudCover', '%'), + cloud_high_cover=to_value(values, 'HighCloudCover', '%'), + precipitation_amount=to_value(values, 'Precipitation1h', 'mm/h'), + radiation_short_wave_acc=to_value(values, 'RadiationGlobalAccumulation', 'J/m²'), + radiation_short_wave_surface_net_acc=to_value(values, 'RadiationNetSurfaceSWAccumulation', 'J/m²'), + radiation_long_wave_acc=to_value(values, 'RadiationLWAccumulation', 'J/m²'), + radiation_long_wave_surface_net_acc=to_value(values, 'RadiationNetSurfaceLWAccumulation', 'J/m²'), + radiation_short_wave_diff_surface_acc=to_value(values, 'RadiationDiffuseAccumulation', 'J/m²'), + geopotential_height=to_value(values, 'GeopHeight', 'm'), + land_sea_mask=to_value(values, 'LandSeaMask', '')) + + +def _float_or_none(value: Any) -> Optional[float]: + """ + Get value as float. None if conversion fails. + :param value: Any value + :return: Value as float if successful; None otherwise + """ + try: + float_value = float(value) + if not math.isnan(float_value): + return float_value + return None + except (ValueError, TypeError): + return None + + +def _is_non_empty_forecast(forecast: Dict[str, float]) -> bool: + """ + Check if forecast contains proper values + :param forecast: Forecast dictionary + :return: True if forecast contains values; False otherwise + """ + for _, value in forecast.items(): + if not math.isnan(value): + return True + + return False diff --git a/fmi_weather_client/utils.py b/fmi_weather_client/utils.py deleted file mode 100644 index c69e1a7..0000000 --- a/fmi_weather_client/utils.py +++ /dev/null @@ -1,26 +0,0 @@ -from typing import Any, Dict, Optional - -import math - - -def float_or_none(v: Any) -> Optional[float]: - """ - Get value as float. None if conversion fails. - :param v: Any value - :return: Value as float if successful; None otherwise - """ - try: - f = float(v) - if not math.isnan(f): - return f - return None - except (ValueError, TypeError): - return None - - -def is_non_empty_forecast(forecast: Dict[str, float]) -> bool: - for _, value in forecast.items(): - if not math.isnan(value): - return True - - return False diff --git a/requirements-dev.txt b/requirements-dev.txt index 3f5f423..28d6cc4 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,2 +1,3 @@ flake8==3.7.9 pytest==5.3.5 +pylint==2.4.4 diff --git a/setup.py b/setup.py index a498872..5907aa4 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="fmi-weather-client", - version="0.0.10", + version="0.0.11", author="Mika Hiltunen", author_email="saaste@gmail.com", description="Library for fetching weather information from Finnish Meteorological Institute (FMI)", @@ -15,7 +15,7 @@ packages=setuptools.find_packages(), install_requires=[ 'asyncio>=3.4.3', - 'requests>=2.22.0', + 'requests>=2.23.0', 'xmltodict>=0.12.0' ], classifiers=[