ims_envista.meteo_data._fix_datetime_offset() - Code Metrics - Inspection of "fix: Fix DateTime according to DST (#70)" - GuyKh/py-ims-envista - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 6f2e14...4eafd4 )

by Guy

created 2024-10-07 07:38 UTC

ims_envista.meteo_data._fix_datetime_offset() A

↳ Parent: ims_envista.meteo_data

Complexity

Conditions

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	10
nop	1
dl	0
loc	18
rs	9.9
c	0
b	0
f	0

"""Data Class for IMS Meteorological Readings."""

from __future__ import annotations

import datetime
import textwrap
import time
from dataclasses import dataclass, field

import pytz

from .const import (
    API_BP,
    API_CHANNELS,
    API_DATA,
    API_DATETIME,
    API_DIFF,
    API_GRAD,
    API_NAME,
    API_NIP,
    API_RAIN,
    API_RAIN_1_MIN,
    API_RH,
    API_STATION_ID,
    API_STATUS,
    API_STD_WD,
    API_TD,
    API_TD_MAX,
    API_TD_MIN,
    API_TG,
    API_TIME,
    API_TW,
    API_VALID,
    API_VALUE,
    API_WD,
    API_WD_MAX,
    API_WS,
    API_WS_1MM,
    API_WS_10MM,
    API_WS_MAX,
    VARIABLES,
)


@dataclass
class MeteorologicalData:
    """Meteorological Data."""

    station_id: int
    """Station ID"""
    datetime: datetime.datetime

    """Date and time of the data"""
    rain: float
    """Rainfall in mm"""
    ws: float
    """Wind speed in m/s"""
    ws_max: float
    """Gust wind speed in m/s"""
    wd: float
    """Wind direction in deg"""
    wd_max: float
    """Gust wind direction in deg"""
    std_wd: float
    """Standard deviation wind direction in deg"""
    td: float
    """Temperature in °C"""
    td_max: float
    """Maximum Temperature in °C"""
    td_min: float
    """Minimum Temperature in °C"""
    tg: float
    """Ground Temperature in °C"""
    tw: float
    """TW Temperature (?) in °C"""
    rh: float
    """Relative humidity in %"""
    ws_1mm: float
    """Maximum 1 minute wind speed in m/s"""
    ws_10mm: float
    """Maximum 10 minute wind speed in m/s"""
    time: datetime.time
    """Time"""
    bp: float
    """Maximum barometric pressure in mb"""
    diff_r: float
    """Distributed radiation in w/m^2"""
    grad: float
    """Global radiation in w/m^2"""
    nip: float
    """Direct radiation in w/m^2"""
    rain_1_min: float
    """Rainfall per minute in mm"""

    def _pretty_print(self) -> str:
        return textwrap.dedent(
            """Station: {}, Date: {}, Readings: [(TD: {}{}), (TDmax: {}{}), (TDmin: {}{}), (TG: {}{}), (RH: {}{}), (Rain: {}{}), (WS: {}{}), (WSmax: {}{}), (WD: {}{}), (WDmax: {}{}),  (STDwd: {}{}), (WS1mm: {}{}), (WS10mm: {}{}), (Time: {}{})]
            """
        ).format(
            self.station_id,
            self.datetime,
            self.td,
            VARIABLES[API_TD].unit,
            self.td_max,
            VARIABLES[API_TD_MAX].unit,
            self.td_min,
            VARIABLES[API_TD_MIN].unit,
            self.tg,
            VARIABLES[API_TG].unit,
            self.rh,
            VARIABLES[API_RH].unit,
            self.rain,
            VARIABLES[API_RAIN].unit,
            self.ws,
            VARIABLES[API_WS].unit,
            self.ws_max,
            VARIABLES[API_WS_MAX].unit,
            self.wd,
            VARIABLES[API_WD].unit,
            self.wd_max,
            VARIABLES[API_WD_MAX].unit,
            self.std_wd,
            VARIABLES[API_STD_WD].unit,
            self.ws_1mm,
            VARIABLES[API_WS_1MM].unit,
            self.ws_10mm,
            VARIABLES[API_WS_10MM].unit,
            self.time,
            VARIABLES[API_TIME].unit,
        )

    def __str__(self) -> str:
        return self._pretty_print()

    def __repr__(self) -> str:
        return self._pretty_print().replace("\n", " ")


@dataclass
class StationMeteorologicalReadings:
    """Station Meteorological Readings."""

    station_id: int
    """ Station Id"""
    data: list[MeteorologicalData] = field(default_factory=list)
    """ List of Meteorological Data """

    def __repr__(self) -> str:
        return textwrap.dedent("""Station ({}), Data: {}""").format(
            self.station_id, self.data
        )

tz = pytz.timezone("Asia/Jerusalem")


def _fix_datetime_offset(dt):
    dt = dt.replace(tzinfo=None)
    dt = tz.localize(dt)

    # Get the UTC offset in seconds
    offset_seconds = dt.utcoffset().total_seconds()

    # Create a fixed timezone with the same offset and name
    fixed_timezone = datetime.timezone(datetime.timedelta(seconds=offset_seconds), dt.tzname())

    # Replace the pytz tzinfo with the fixed timezone
    dt = dt.replace(tzinfo=fixed_timezone)

    is_dst = dt.dst() != datetime.timedelta(0)
    if is_dst:
        dt = dt + datetime.timedelta(hours=1)

    return dt,is_dst


def meteo_data_from_json(station_id: int, data: dict) -> MeteorologicalData:
    """Create a MeteorologicalData object from a JSON object."""
    dt = datetime.datetime.fromisoformat(data[API_DATETIME])
    dt, is_dst = _fix_datetime_offset(dt)

    channel_value_dict = {}
    for channel_value in data[API_CHANNELS]:
        if channel_value[API_VALID] is True and channel_value[API_STATUS] == 1:
            channel_value_dict[channel_value[API_NAME]] = float(
                channel_value[API_VALUE]
            )

    rain = channel_value_dict.get(API_RAIN)
    ws_max = channel_value_dict.get(API_WS_MAX)
    wd_max = channel_value_dict.get(API_WD_MAX)
    ws = channel_value_dict.get(API_WS)
    wd = channel_value_dict.get(API_WD)
    std_wd = channel_value_dict.get(API_STD_WD)
    td = channel_value_dict.get(API_TD)
    rh = channel_value_dict.get(API_RH)
    td_max = channel_value_dict.get(API_TD_MAX)
    td_min = channel_value_dict.get(API_TD_MIN)
    ws_1mm = channel_value_dict.get(API_WS_1MM)
    ws_10mm = channel_value_dict.get(API_WS_10MM)
    tg = channel_value_dict.get(API_TG)
    tw = channel_value_dict.get(API_TW)
    time_val = channel_value_dict.get(API_TIME)
    if time_val:
        t = time.strptime(str(int(time_val)), "%H%M")
        time_val = datetime.time(t.tm_hour, t.tm_min, tzinfo=tz)
    bp = channel_value_dict.get(API_BP)
    diff_r = channel_value_dict.get(API_DIFF)
    grad = channel_value_dict.get(API_GRAD)
    nip = channel_value_dict.get(API_NIP)
    rain_1_min = channel_value_dict.get(API_RAIN_1_MIN)

    if is_dst and time_val:
        # Strange IMS logic :o
        dt = dt + datetime.timedelta(hours=1)
        time_val = time_val.replace(hour=(time_val.hour+1)%24)

    return MeteorologicalData(
        station_id=station_id,
        datetime=dt,
        rain=rain,
        ws=ws,
        ws_max=ws_max,
        wd=wd,
        wd_max=wd_max,
        std_wd=std_wd,
        td=td,
        td_max=td_max,
        td_min=td_min,
        tg=tg,
        tw=tw,
        rh=rh,
        ws_1mm=ws_1mm,
        ws_10mm=ws_10mm,
        time=time_val,
        bp=bp,
        diff_r=diff_r,
        grad=grad,
        nip=nip,
        rain_1_min=rain_1_min
    )


def station_meteo_data_from_json(json: dict) -> StationMeteorologicalReadings | None:
    station_id = int(json[API_STATION_ID])
    data = json.get(API_DATA)
    if not data:
        return None
    meteo_data = [meteo_data_from_json(station_id, single_meteo_data) for single_meteo_data in data]
    return StationMeteorologicalReadings(station_id, meteo_data)


1			"""Data Class for IMS Meteorological Readings."""
2
3			from __future__ import annotations
4
5			import datetime
6			import textwrap
7			import time
8			from dataclasses import dataclass, field
9
10			import pytz
11
12			from .const import (
13			API_BP,
14			API_CHANNELS,
15			API_DATA,
16			API_DATETIME,
17			API_DIFF,
18			API_GRAD,
19			API_NAME,
20			API_NIP,
21			API_RAIN,
22			API_RAIN_1_MIN,
23			API_RH,
24			API_STATION_ID,
25			API_STATUS,
26			API_STD_WD,
27			API_TD,
28			API_TD_MAX,
29			API_TD_MIN,
30			API_TG,
31			API_TIME,
32			API_TW,
33			API_VALID,
34			API_VALUE,
35			API_WD,
36			API_WD_MAX,
37			API_WS,
38			API_WS_1MM,
39			API_WS_10MM,
40			API_WS_MAX,
41			VARIABLES,
42			)
43
44
45			@dataclass
46			class MeteorologicalData:
47			"""Meteorological Data."""
48
49			station_id: int
50			"""Station ID"""
51			datetime: datetime.datetime
			0 ignored issues – show Comprehensibility Best Practice introduced 2023-03-01 09:08 UTC by Report Bug Copy Issue Report The variable `datetime` does not seem to be defined. Loading history...
52			"""Date and time of the data"""
53			rain: float
54			"""Rainfall in mm"""
55			ws: float
56			"""Wind speed in m/s"""
57			ws_max: float
58			"""Gust wind speed in m/s"""
59			wd: float
60			"""Wind direction in deg"""
61			wd_max: float
62			"""Gust wind direction in deg"""
63			std_wd: float
64			"""Standard deviation wind direction in deg"""
65			td: float
66			"""Temperature in °C"""
67			td_max: float
68			"""Maximum Temperature in °C"""
69			td_min: float
70			"""Minimum Temperature in °C"""
71			tg: float
72			"""Ground Temperature in °C"""
73			tw: float
74			"""TW Temperature (?) in °C"""
75			rh: float
76			"""Relative humidity in %"""
77			ws_1mm: float
78			"""Maximum 1 minute wind speed in m/s"""
79			ws_10mm: float
80			"""Maximum 10 minute wind speed in m/s"""
81			time: datetime.time
82			"""Time"""
83			bp: float
84			"""Maximum barometric pressure in mb"""
85			diff_r: float
86			"""Distributed radiation in w/m^2"""
87			grad: float
88			"""Global radiation in w/m^2"""
89			nip: float
90			"""Direct radiation in w/m^2"""
91			rain_1_min: float
92			"""Rainfall per minute in mm"""
93
94			def _pretty_print(self) -> str:
95			return textwrap.dedent(
96			"""Station: {}, Date: {}, Readings: [(TD: {}{}), (TDmax: {}{}), (TDmin: {}{}), (TG: {}{}), (RH: {}{}), (Rain: {}{}), (WS: {}{}), (WSmax: {}{}), (WD: {}{}), (WDmax: {}{}), (STDwd: {}{}), (WS1mm: {}{}), (WS10mm: {}{}), (Time: {}{})]
97			"""
98			).format(
99			self.station_id,
100			self.datetime,
101			self.td,
102			VARIABLES[API_TD].unit,
103			self.td_max,
104			VARIABLES[API_TD_MAX].unit,
105			self.td_min,
106			VARIABLES[API_TD_MIN].unit,
107			self.tg,
108			VARIABLES[API_TG].unit,
109			self.rh,
110			VARIABLES[API_RH].unit,
111			self.rain,
112			VARIABLES[API_RAIN].unit,
113			self.ws,
114			VARIABLES[API_WS].unit,
115			self.ws_max,
116			VARIABLES[API_WS_MAX].unit,
117			self.wd,
118			VARIABLES[API_WD].unit,
119			self.wd_max,
120			VARIABLES[API_WD_MAX].unit,
121			self.std_wd,
122			VARIABLES[API_STD_WD].unit,
123			self.ws_1mm,
124			VARIABLES[API_WS_1MM].unit,
125			self.ws_10mm,
126			VARIABLES[API_WS_10MM].unit,
127			self.time,
128			VARIABLES[API_TIME].unit,
129			)
130
131			def __str__(self) -> str:
132			return self._pretty_print()
133
134			def __repr__(self) -> str:
135			return self._pretty_print().replace("\n", " ")
136
137
138			@dataclass
139			class StationMeteorologicalReadings:
140			"""Station Meteorological Readings."""
141
142			station_id: int
143			""" Station Id"""
144			data: list[MeteorologicalData] = field(default_factory=list)
145			""" List of Meteorological Data """
146
147			def __repr__(self) -> str:
148			return textwrap.dedent("""Station ({}), Data: {}""").format(
149			self.station_id, self.data
150			)
151
152			tz = pytz.timezone("Asia/Jerusalem")
153
154
155			def _fix_datetime_offset(dt):
156			dt = dt.replace(tzinfo=None)
157			dt = tz.localize(dt)
158
159			# Get the UTC offset in seconds
160			offset_seconds = dt.utcoffset().total_seconds()
161
162			# Create a fixed timezone with the same offset and name
163			fixed_timezone = datetime.timezone(datetime.timedelta(seconds=offset_seconds), dt.tzname())
164
165			# Replace the pytz tzinfo with the fixed timezone
166			dt = dt.replace(tzinfo=fixed_timezone)
167
168			is_dst = dt.dst() != datetime.timedelta(0)
169			if is_dst:
170			dt = dt + datetime.timedelta(hours=1)
171
172			return dt,is_dst
173
174
175			def meteo_data_from_json(station_id: int, data: dict) -> MeteorologicalData:
176			"""Create a MeteorologicalData object from a JSON object."""
177			dt = datetime.datetime.fromisoformat(data[API_DATETIME])
178			dt, is_dst = _fix_datetime_offset(dt)
179
180			channel_value_dict = {}
181			for channel_value in data[API_CHANNELS]:
182			if channel_value[API_VALID] is True and channel_value[API_STATUS] == 1:
183			channel_value_dict[channel_value[API_NAME]] = float(
184			channel_value[API_VALUE]
185			)
186
187			rain = channel_value_dict.get(API_RAIN)
188			ws_max = channel_value_dict.get(API_WS_MAX)
189			wd_max = channel_value_dict.get(API_WD_MAX)
190			ws = channel_value_dict.get(API_WS)
191			wd = channel_value_dict.get(API_WD)
192			std_wd = channel_value_dict.get(API_STD_WD)
193			td = channel_value_dict.get(API_TD)
194			rh = channel_value_dict.get(API_RH)
195			td_max = channel_value_dict.get(API_TD_MAX)
196			td_min = channel_value_dict.get(API_TD_MIN)
197			ws_1mm = channel_value_dict.get(API_WS_1MM)
198			ws_10mm = channel_value_dict.get(API_WS_10MM)
199			tg = channel_value_dict.get(API_TG)
200			tw = channel_value_dict.get(API_TW)
201			time_val = channel_value_dict.get(API_TIME)
202			if time_val:
203			t = time.strptime(str(int(time_val)), "%H%M")
204			time_val = datetime.time(t.tm_hour, t.tm_min, tzinfo=tz)
205			bp = channel_value_dict.get(API_BP)
206			diff_r = channel_value_dict.get(API_DIFF)
207			grad = channel_value_dict.get(API_GRAD)
208			nip = channel_value_dict.get(API_NIP)
209			rain_1_min = channel_value_dict.get(API_RAIN_1_MIN)
210
211			if is_dst and time_val:
212			# Strange IMS logic :o
213			dt = dt + datetime.timedelta(hours=1)
214			time_val = time_val.replace(hour=(time_val.hour+1)%24)
215
216			return MeteorologicalData(
217			station_id=station_id,
218			datetime=dt,
219			rain=rain,
220			ws=ws,
221			ws_max=ws_max,
222			wd=wd,
223			wd_max=wd_max,
224			std_wd=std_wd,
225			td=td,
226			td_max=td_max,
227			td_min=td_min,
228			tg=tg,
229			tw=tw,
230			rh=rh,
231			ws_1mm=ws_1mm,
232			ws_10mm=ws_10mm,
233			time=time_val,
234			bp=bp,
235			diff_r=diff_r,
236			grad=grad,
237			nip=nip,
238			rain_1_min=rain_1_min
239			)
240
241
242			def station_meteo_data_from_json(json: dict) -> StationMeteorologicalReadings \| None:
243			station_id = int(json[API_STATION_ID])
244			data = json.get(API_DATA)
245			if not data:
246			return None
247			meteo_data = [meteo_data_from_json(station_id, single_meteo_data) for single_meteo_data in data]
248			return StationMeteorologicalReadings(station_id, meteo_data)
249

GuyKh / py-ims-envista

Push — main ( 6f2e14...4eafd4 )

ims_envista.meteo_data._fix_datetime_offset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like