File: utils.py

package info (click to toggle)
rows 0.5.0~dev0~1~1d5a326-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,340 kB
  • sloc: python: 12,672; sh: 117; makefile: 67
file content (372 lines) | stat: -rw-r--r-- 13,881 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# coding: utf-8

# Copyright 2014-2025 Álvaro Justen <https://github.com/turicas/rows/>
#    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
#    Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
#    any later version.
#    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
#    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
#    more details.
#    You should have received a copy of the GNU Lesser General Public License along with this program.  If not, see
#    <http://www.gnu.org/licenses/>.

from __future__ import unicode_literals

import copy
import datetime
import os
import subprocess
from collections import OrderedDict
from decimal import Decimal
from pathlib import Path


import rows.fields as fields
from rows.fields import slug
from rows.table import Table
from rows.compat import TEXT_TYPE

process = None
try:
    process = subprocess.Popen(["psql", "--version"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
except OSError:
    PSQL_FOUND = False
else:
    PSQL_FOUND = True
finally:
    if process:
        process.wait()


NONE_VALUES = list(fields.NULL) + ["", None]
FIELDS = OrderedDict(
    [
        ("bool_column", fields.BoolField),
        ("integer_column", fields.IntegerField),
        ("float_column", fields.FloatField),
        ("decimal_column", fields.FloatField),
        ("percent_column", fields.PercentField),
        ("date_column", fields.DateField),
        ("datetime_column", fields.DatetimeField),
        ("unicode_column", fields.TextField),
    ]
)
FIELD_NAMES = list(FIELDS.keys())
EXPECTED_ROWS = [
    {
        "float_column": 3.141592,
        "decimal_column": 3.141592,
        "bool_column": True,
        "integer_column": 1,
        "date_column": datetime.date(2015, 1, 1),
        "datetime_column": datetime.datetime(2015, 8, 18, 15, 10),
        "percent_column": Decimal("0.01"),
        "unicode_column": "Álvaro",
    },
    {
        "float_column": 1.234,
        "decimal_column": 1.234,
        "bool_column": False,
        "integer_column": 2,
        "date_column": datetime.date(1999, 2, 3),
        "datetime_column": datetime.datetime(1999, 2, 3, 0, 1, 2),
        "percent_column": Decimal("0.1169"),
        "unicode_column": "àáãâä¹²³",
    },
    {
        "float_column": 4.56,
        "decimal_column": 4.56,
        "bool_column": True,
        "integer_column": 3,
        "date_column": datetime.date(2050, 1, 2),
        "datetime_column": datetime.datetime(2050, 1, 2, 23, 45, 31),
        "percent_column": Decimal("0.12"),
        "unicode_column": "éèẽêë",
    },
    {
        "float_column": 7.89,
        "decimal_column": 7.89,
        "bool_column": False,
        "integer_column": 4,
        "date_column": datetime.date(2015, 8, 18),
        "datetime_column": datetime.datetime(2015, 8, 18, 22, 21, 33),
        "percent_column": Decimal("0.1364"),
        "unicode_column": "~~~~",
    },
    {
        "float_column": 9.87,
        "decimal_column": 9.87,
        "bool_column": True,
        "integer_column": 5,
        "date_column": datetime.date(2015, 3, 4),
        "datetime_column": datetime.datetime(2015, 3, 4, 16, 0, 1),
        "percent_column": Decimal("0.1314"),
        "unicode_column": "álvaro",
    },
    {
        "float_column": 1.2345,
        "decimal_column": 1.2345,
        "bool_column": False,
        "integer_column": 6,
        "date_column": datetime.date(2015, 5, 6),
        "datetime_column": datetime.datetime(2015, 5, 6, 12, 1, 2),
        "percent_column": Decimal("0.02"),
        "unicode_column": "test",
    },
    {
        "float_column": None,
        "decimal_column": None,
        "bool_column": None,
        "integer_column": None,
        "date_column": None,
        "datetime_column": None,
        "percent_column": None,
        "unicode_column": "",
    },
]
table = Table(fields=FIELDS)
for row in EXPECTED_ROWS:
    table.append(row)
table._meta = {"test": 123}


class LazyGenerator(object):
    def __init__(self, max_number):
        self.max_number = max_number
        self.last = None

    def __iter__(self):
        yield ["number", "number_sq", "number_double"]
        for number in range(self.max_number):
            self.last = number
            yield [self.last, self.last ** 2, self.last * 2]


class LazyDictGenerator(LazyGenerator):
    def __iter__(self):
        header = ("number", "number_sq", "number_double")
        for number in range(self.max_number):
            self.last = number
            data = (self.last, self.last ** 2, self.last * 2)
            yield dict(zip(header, data))


class RowsTestMixIn(object):

    maxDiff = None
    override_fields = None

    def setUp(self):
        self.files_to_delete = []

    def tearDown(self):
        for filename in self.files_to_delete:
            if os.path.exists(filename):
                os.unlink(filename)

    def assert_table_equal(self, first, second):
        expected_fields = dict(second.fields)
        override_fields = self.override_fields or {}
        expected_fields = copy.deepcopy(expected_fields)
        for key, value in override_fields.items():
            if key in expected_fields:
                expected_fields[key] = value

        self.assertDictEqual(dict(first.fields), expected_fields)
        assert len(first) == len(second)

        for first_row, second_row in zip(first, second):
            first_row = dict(first_row._asdict())
            second_row = dict(second_row._asdict())
            for field_name, field_type in expected_fields.items():
                value = first_row[field_name]
                expected_value = second_row[field_name]
                if field_name in override_fields:
                    expected_value = override_fields[field_name].deserialize(
                        expected_value
                    )
                if float not in (type(value), type(expected_value)):
                    assert value == expected_value
                else:
                    self.assertAlmostEqual(value, expected_value, places=5)

    def assert_file_contents_equal(self, first_filename, second_filename):
        with open(first_filename, "rb") as fobj:
            first = fobj.read()
        with open(second_filename, "rb") as fobj:
            second = fobj.read()
        assert first == second

    def assert_create_table_data(
        self, call_args, field_ordering=True, filename=None, expected_meta=None
    ):

        if filename is None and getattr(self, "name", None):
            filename = self.filename
        kwargs = call_args[1].copy()
        if expected_meta is None:
            expected_meta = {
                "imported_from": self.plugin_name,
                "name": slug(os.path.splitext(Path(filename).name)[0])
                if filename
                else "table1",
            }
        else:
            expected_meta = expected_meta.copy()

        # Don't test 'frame_style' metadata,
        # as it is specific for txt importing
        # (and the default values for it might change)
        if "frame_style" not in expected_meta:
            kwargs["meta"].pop("frame_style", "")

        meta = kwargs["meta"].copy()

        # TODO: may test source in another way
        source = meta.pop("source", None)
        if source:
            expected_source = expected_meta.pop("source", None)
            if expected_source:
                source_uri = Path(source.uri).absolute()
                expected_uri = Path(expected_source.uri).absolute()
                assert source_uri == expected_uri

        self.assertDictEqual(meta, expected_meta)
        del kwargs["meta"]
        self.assert_table_data(
            call_args[0][0], args=[], kwargs=kwargs, field_ordering=field_ordering
        )

    def assert_table_data(self, data, args, kwargs, field_ordering):
        data = list(data)
        data[0] = list(data[0])
        if field_ordering:
            assert data[0] == FIELD_NAMES

            for row_index, row in enumerate(data[1:]):
                for column_index, value in enumerate(row):
                    field_name = FIELD_NAMES[column_index]
                    expected_value = EXPECTED_ROWS[row_index][field_name]
                    self.field_assert(
                        field_name, expected_value, value, *args, **kwargs
                    )
        else:
            assert set(data[0]) == set(FIELD_NAMES)
            for row_index, row in enumerate(data[1:]):
                for column_index, value in enumerate(row):
                    field_name = data[0][column_index]
                    expected_value = EXPECTED_ROWS[row_index][field_name]
                    self.field_assert(
                        field_name, expected_value, value, *args, **kwargs
                    )

    # Fields asserts: input values we expect from plugins

    def field_assert(self, field_name, expected_value, value, *args, **kwargs):
        assert_methods = {
            fields.BoolField: self.assert_BoolField,
            fields.DateField: self.assert_DateField,
            fields.DatetimeField: self.assert_DatetimeField,
            fields.DecimalField: self.assert_DecimalField,
            fields.FloatField: self.assert_FloatField,
            fields.IntegerField: self.assert_IntegerField,
            fields.PercentField: self.assert_PercentField,
            fields.TextField: self.assert_TextField,
        }
        if self.override_fields and field_name in self.override_fields:
            FieldClass = self.override_fields[field_name]
        else:
            FieldClass = FIELDS[field_name]

        return assert_methods[FieldClass](expected_value, value, *args, **kwargs)

    def assert_BoolField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        elif expected_value is True:
            assert TEXT_TYPE(value).lower() in ("true", b"true", "yes", b"yes")
        elif expected_value is False:
            assert TEXT_TYPE(value).lower() in ("false", b"false", "no", b"no")
        else:
            raise ValueError("expected_value is not True or False")

    def assert_IntegerField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        else:
            assert value in (expected_value, TEXT_TYPE(expected_value))

    def assert_FloatField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        elif type(value) != type(expected_value):
            assert TEXT_TYPE(value) == TEXT_TYPE(expected_value)
        else:
            self.assertAlmostEqual(expected_value, value, places=5)

    def assert_DecimalField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        else:
            self.assert_FloatField(expected_value, value)

    def assert_PercentField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        else:
            float_value = TEXT_TYPE(Decimal(expected_value) * 100)[:-2]
            if float_value.endswith("."):
                float_value = float_value[:-1]

            possible_values = []

            if "." not in float_value:
                possible_values.append(TEXT_TYPE(int(float_value)) + "%")
                possible_values.append(TEXT_TYPE(int(float_value)) + ".00%")

            float_value = float(float_value)
            possible_values.extend(
                [
                    TEXT_TYPE(float_value) + "%",
                    TEXT_TYPE(float_value) + ".0%",
                    TEXT_TYPE(float_value) + ".00%",
                ]
            )

            assert value in possible_values

    def assert_DateField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        else:
            value = TEXT_TYPE(value)
            if value.endswith("00:00:00"):
                value = value[:-9]
            assert TEXT_TYPE(expected_value) == value

    def assert_DatetimeField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        elif (
            type(value) is datetime.datetime
            and type(expected_value) is datetime.datetime
        ):
            # if both types are datetime, check delta
            # XLSX plugin has not a good precision and will change milliseconds
            delta_1 = expected_value - value
            delta_2 = value - expected_value
            assert TEXT_TYPE(delta_1).startswith("0:00:00") or TEXT_TYPE(delta_2).startswith("0:00:00")
        else:
            # if not, convert values to string and verify if are equal
            value = TEXT_TYPE(value)
            assert TEXT_TYPE(expected_value).replace(" ", "T") == value

    def assert_TextField(self, expected_value, value, *args, **kwargs):
        if expected_value is None:
            assert value is None or value.lower() in NONE_VALUES
        elif expected_value == "":
            # Some plugins return `None` instead of empty strings for cells
            # with blank values and we don't have an way to differentiate
            assert value in (None, "")
        else:
            assert expected_value == value