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
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all JSON 2 CSV migrators.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import functools
from typing import Optional
import PyFunceble.facility
from PyFunceble.cli.migrators.base import MigratorBase
from PyFunceble.dataset.csv_base import CSVDatasetBase
class JSON2CSVMigratorBase(MigratorBase):
"""
Provides the base of all JSON to CSV related classes.
"""
source_file: Optional[str] = None
dataset: Optional[CSVDatasetBase] = None
def ensure_source_file_is_given(func): # pylint: disable=no-self-argument
"""
Ensures that the source file is given before launching the decorated
method.
:raise RuntimeError:
When the:code:`self.source_file` is not given.
"""
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if not isinstance(self.source_file, str):
raise RuntimeError("<self.source_file> is not given.")
return func(self, *args, **kwargs) # pylint: disable=not-callable
return wrapper
def ensure_dataset_is_given(func): # pylint: disable=no-self-argument
"""
Ensures that the dataset is given before launching the decorated
method.
:raise RuntimeError:
When the:code:`self.source_file` is not given.
"""
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if not isinstance(self.dataset, CSVDatasetBase):
raise RuntimeError("<self.dataset> is not given.")
return func(self, *args, **kwargs) # pylint: disable=not-callable
return wrapper
def migrate(self) -> "JSON2CSVMigratorBase":
"""
Provides the migrator (itself)
"""
raise NotImplementedError()
@ensure_source_file_is_given
@ensure_dataset_is_given
def start(self) -> "JSON2CSVMigratorBase":
"""
Starts the migration and everything related to it.
"""
PyFunceble.facility.Logger.info("Started migration.")
self.migrate()
PyFunceble.facility.Logger.info("Finished migration.")
return self
|
