-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathbase.html
More file actions
1070 lines (923 loc) · 53.5 KB
/
base.html
File metadata and controls
1070 lines (923 loc) · 53.5 KB
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>keboola.component.base API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>keboola.component.base</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import contextlib
import json
import logging
import os
import sys
from abc import ABC
from abc import abstractmethod
from functools import wraps
from pathlib import Path
from typing import Dict
from typing import Union, List, Optional
from . import dao
from . import table_schema as ts
from .interface import CommonInterface
from .sync_actions import SyncActionResult, process_sync_action_result
KEY_DEBUG = 'debug'
# Mapping of sync actions "action name":"method_name"
_SYNC_ACTION_MAPPING = {"run": "run"}
def sync_action(action_name: str):
"""
Decorator for marking sync actions method.
For more info see [Sync actions](https://developers.keboola.com/extend/common-interface/actions/).
Usage:
```
import csv
import logging
from keboola.component.base import ComponentBase, sync_action
class Component(ComponentBase):
def run(self):
'''
Main execution code
'''
pass
# sync action that is executed when configuration.json "action":"testConnection" parameter is present.
@sync_action('testConnection')
def test_connection(self):
connection = self.configuration.parameters.get('test_connection')
if connection == "fail":
raise UserException("failed")
elif connection == "succeed":
# this is ignored when run as sync action.
logging.info("succeed")
if __name__ == "__main__":
try:
comp = Component()
# this triggers the run method by default and is controlled by the configuration.action parameter
comp.execute_action()
except UserException as exc:
logging.exception(exc)
exit(1)
except Exception as exc:
logging.exception(exc)
exit(2)
```
Args:
action_name: Name of the action registered in Developer Portal
Returns:
"""
def decorate(func):
# to allow pythonic names / action name mapping
if action_name == 'run':
raise ValueError('Sync action name "run" is reserved base action! Use different name.')
_SYNC_ACTION_MAPPING[action_name] = func.__name__
@wraps(func)
def action_wrapper(self, *args, **kwargs):
# override when run as sync action, because it could be also called normally within run
is_sync_action = self.configuration.action != 'run'
# do operations with func
if is_sync_action:
stdout_redirect = None
# mute logging just in case
logging.getLogger().setLevel(logging.FATAL)
else:
stdout_redirect = sys.stdout
try:
# when success, only supported syntax can be in output / log, so redirect stdout before.
with contextlib.redirect_stdout(stdout_redirect):
result: Union[None, SyncActionResult, List[SyncActionResult]] = func(self, *args, **kwargs)
if is_sync_action:
# sync action expects valid JSON in stdout on success.
result_str = process_sync_action_result(result)
# handle cases, when there is sync action called from another sync_action
try:
sys.stdout.write(result_str)
except AttributeError:
pass
return result
except Exception as e:
if is_sync_action:
# sync actions expect stderr
sys.stderr.write(str(e))
exit(1)
else:
raise e
return action_wrapper
return decorate
class ComponentBase(ABC, CommonInterface):
def __init__(self, data_path_override: Optional[str] = None,
schema_path_override: Optional[str] = None,
required_parameters: Optional[list] = None,
required_image_parameters: Optional[list] = None):
"""
Base class for general Python components. Initializes the CommonInterface
and performs configuration validation.
For easier debugging the data folder is picked up by default from `../data` path,
relative to working directory.
If `debug` parameter is present in the `config.json`, the default logger is set to verbose DEBUG mode.
It executes [Sync actions](https://developers.keboola.com/extend/common-interface/actions/)
when "action" is defined in the configuration.json based on the @action_decorator.
Args:
data_path_override:
optional path to data folder that overrides the default behaviour (`KBC_DATADIR` environment variable).
May be also specified by '-d' or '--data' commandline argument
required_parameters:
Optional[dict]: DEPRECATED required configuration parameters, if filled in,
validation is done at constructor level
required_image_parameters:
Optional[dict]: DEPRECATED required image parameters, if filled in,
validation is done at constructor level
Raises:
UserException - on config validation errors.
"""
# for easier local project setup
super().__init__(data_folder_path=self._get_data_folder_override_path(data_path_override))
if required_parameters:
self.validate_configuration_parameters(required_parameters)
if required_image_parameters:
self.validate_image_parameters(required_image_parameters)
if self.configuration.parameters.get(KEY_DEBUG):
self.set_debug_mode()
self.schema_folder_path = self._get_schema_folder_path(schema_path_override)
@staticmethod
def _get_default_data_path() -> str:
"""
Returns default data_path, by default `../data` is used, relative to working directory.
This helps with local development.
Returns:
"""
return Path(os.getcwd()).resolve().parent.joinpath('data').as_posix()
def _get_data_folder_override_path(self, data_path_override: str = None) -> str:
"""
Returns overridden value of the data_folder_path in case the data_path_override variable
or `KBC_DATADIR` environment variable is defined. The `data_path_override` variable takes precendence.
Returns null if override is not in place.
Args:
data_path_override:
Returns:
"""
data_folder_path = None
if data_path_override:
data_folder_path = data_path_override
elif not os.environ.get('KBC_DATADIR'):
data_folder_path = self._get_default_data_path()
return data_folder_path
def _get_schema_folder_path(self, schema_path_override: str = None) -> str:
"""
Returns value of the schema_folder_path in case the schema_path_override variable is provided or
the default schema_folder_path is found.
"""
return schema_path_override or self._get_default_schema_folder_path()
@staticmethod
def _get_default_schema_folder_path() -> Optional[str]:
"""
Finds the default schema_folder_path if it exists.
"""
container_schema_dir = Path("./src/schemas/").absolute().as_posix()
local_schema_dir = Path("./schemas").absolute().as_posix()
if os.path.isdir(container_schema_dir):
return container_schema_dir
elif os.path.isdir(local_schema_dir):
return local_schema_dir
@staticmethod
def set_debug_mode():
"""
Set the default logger to verbose mode.
Returns:
"""
logging.getLogger().setLevel(logging.DEBUG)
@abstractmethod
def run(self):
"""
Main execution code of default run action.
"""
pass
def execute_action(self):
"""
Executes action defined in the configuration.
The default action is 'run'. See base._SYNC_ACTION_MAPPING
"""
action = self.configuration.action
if not action:
logging.warning("No action defined in the configuration, using the default run action.")
action = 'run'
try:
action = _SYNC_ACTION_MAPPING[action]
action_method = getattr(self, action)
except (AttributeError, KeyError) as e:
raise AttributeError(f"The defined action {action} is not implemented!") from e
return action_method()
def create_out_table_definition_from_schema(self, table_schema: ts.TableSchema, is_sliced: bool = False,
destination: str = '', incremental: bool = None,
enclosure: str = '"', delimiter: str = ',',
delete_where: dict = None) -> dao.TableDefinition:
"""
Creates an out table definition using a defined table schema.
This method uses the given table schema and generates metadata of the table. Along with the additional
key word arguments it creates an out table definition.
Args:
table_schema : table of the schema for which a table definition will be created
is_sliced: True if the full_path points to a folder with sliced tables
destination: String name of the table in Storage.
incremental: Set to true to enable incremental loading
enclosure: str: CSV enclosure, by default "
delimiter: str: CSV delimiter, by default ,
delete_where: Dict with settings for deleting rows
Returns:
TableDefinition object initialized with all table metadata defined in a schema
"""
table_metadata = self._generate_table_metadata(table_schema)
return self.create_out_table_definition(name=table_schema.csv_name,
columns=table_schema.field_names,
primary_key=table_schema.primary_keys,
table_metadata=table_metadata,
is_sliced=is_sliced,
destination=destination,
incremental=incremental,
enclosure=enclosure,
delimiter=delimiter,
delete_where=delete_where)
def get_table_schema_by_name(self, schema_name: str,
schema_folder_path: Optional[str] = None) -> ts.TableSchema:
"""
The method finds a table schema JSON based on it's name in a defined schema_folder_path and generates
a TableSchema object.
Args:
schema_name : name of the schema in the schema_folder_path. e.g. for schema in 'src/schemas/order.json'
schema_name is 'order'
schema_folder_path : directory path to the schema folder, by default the schema folder is set at
'src/schemas'
Returns:
TableSchema object initialized with all available table metadata
"""
if not schema_folder_path:
schema_folder_path = self.schema_folder_path
self._validate_schema_folder_path(schema_folder_path)
schema_dict = self._load_table_schema_dict(schema_name, schema_folder_path)
return ts.init_table_schema_from_dict(schema_dict)
@staticmethod
def _load_table_schema_dict(schema_name: str, schema_folder_path: str) -> Dict:
try:
with open(os.path.join(schema_folder_path, f"{schema_name}.json"), 'r') as schema_file:
json_schema = json.loads(schema_file.read())
except FileNotFoundError as file_err:
raise FileNotFoundError(
f"Schema for corresponding schema name : {schema_name} is not found in the schema directory. "
f"Make sure that '{schema_name}'.json "
f"exists in the directory '{schema_folder_path}'") from file_err
return json_schema
@staticmethod
def _validate_schema_folder_path(schema_folder_path: str):
if not schema_folder_path or not os.path.isdir(schema_folder_path):
raise FileNotFoundError("A schema folder path must be defined in order to create a out table definition "
"from a schema. If a schema folder path is not defined, the schemas folder must be"
" located in the 'src' directory of a component : src/schemas")
def _generate_table_metadata(self, table_schema: ts.TableSchema) -> dao.TableMetadata:
"""
Generates a TableMetadata object for the table definition using a TableSchema object.
"""
table_metadata = dao.TableMetadata()
if table_schema.description:
table_metadata.add_table_description(table_schema.description)
table_metadata.add_column_descriptions({field.name: field.description for field in table_schema.fields})
table_metadata = self._add_field_data_types_to_table_metadata(table_schema, table_metadata)
return table_metadata
@staticmethod
def _add_field_data_types_to_table_metadata(table_schema: ts.TableSchema,
table_metadata: dao.TableMetadata) -> dao.TableMetadata:
"""
Adds data types of all fields specified in a TableSchema object to a given TableMetadata object
"""
for field in table_schema.fields:
if field.base_type:
table_metadata.add_column_data_type(field.name,
data_type=field.base_type,
nullable=field.nullable,
length=field.length,
default=field.default)
return table_metadata</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="keboola.component.base.sync_action"><code class="name flex">
<span>def <span class="ident">sync_action</span></span>(<span>action_name: str)</span>
</code></dt>
<dd>
<div class="desc"><p>Decorator for marking sync actions method.
For more info see <a href="https://developers.keboola.com/extend/common-interface/actions/">Sync actions</a>.</p>
<pre><code>Usage:
</code></pre>
<pre><code>import csv
import logging
from keboola.component.base import ComponentBase, sync_action
class Component(ComponentBase):
def run(self):
'''
Main execution code
'''
pass
# sync action that is executed when configuration.json "action":"testConnection" parameter is present.
@sync_action('testConnection')
def test_connection(self):
connection = self.configuration.parameters.get('test_connection')
if connection == "fail":
raise UserException("failed")
elif connection == "succeed":
# this is ignored when run as sync action.
logging.info("succeed")
if __name__ == "__main__":
try:
comp = Component()
# this triggers the run method by default and is controlled by the configuration.action parameter
comp.execute_action()
except UserException as exc:
logging.exception(exc)
exit(1)
except Exception as exc:
logging.exception(exc)
exit(2)
</code></pre>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>action_name</code></strong></dt>
<dd>Name of the action registered in Developer Portal</dd>
</dl>
<p>Returns:</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def sync_action(action_name: str):
"""
Decorator for marking sync actions method.
For more info see [Sync actions](https://developers.keboola.com/extend/common-interface/actions/).
Usage:
```
import csv
import logging
from keboola.component.base import ComponentBase, sync_action
class Component(ComponentBase):
def run(self):
'''
Main execution code
'''
pass
# sync action that is executed when configuration.json "action":"testConnection" parameter is present.
@sync_action('testConnection')
def test_connection(self):
connection = self.configuration.parameters.get('test_connection')
if connection == "fail":
raise UserException("failed")
elif connection == "succeed":
# this is ignored when run as sync action.
logging.info("succeed")
if __name__ == "__main__":
try:
comp = Component()
# this triggers the run method by default and is controlled by the configuration.action parameter
comp.execute_action()
except UserException as exc:
logging.exception(exc)
exit(1)
except Exception as exc:
logging.exception(exc)
exit(2)
```
Args:
action_name: Name of the action registered in Developer Portal
Returns:
"""
def decorate(func):
# to allow pythonic names / action name mapping
if action_name == 'run':
raise ValueError('Sync action name "run" is reserved base action! Use different name.')
_SYNC_ACTION_MAPPING[action_name] = func.__name__
@wraps(func)
def action_wrapper(self, *args, **kwargs):
# override when run as sync action, because it could be also called normally within run
is_sync_action = self.configuration.action != 'run'
# do operations with func
if is_sync_action:
stdout_redirect = None
# mute logging just in case
logging.getLogger().setLevel(logging.FATAL)
else:
stdout_redirect = sys.stdout
try:
# when success, only supported syntax can be in output / log, so redirect stdout before.
with contextlib.redirect_stdout(stdout_redirect):
result: Union[None, SyncActionResult, List[SyncActionResult]] = func(self, *args, **kwargs)
if is_sync_action:
# sync action expects valid JSON in stdout on success.
result_str = process_sync_action_result(result)
# handle cases, when there is sync action called from another sync_action
try:
sys.stdout.write(result_str)
except AttributeError:
pass
return result
except Exception as e:
if is_sync_action:
# sync actions expect stderr
sys.stderr.write(str(e))
exit(1)
else:
raise e
return action_wrapper
return decorate</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="keboola.component.base.ComponentBase"><code class="flex name class">
<span>class <span class="ident">ComponentBase</span></span>
<span>(</span><span>data_path_override: Optional[str] = None, schema_path_override: Optional[str] = None, required_parameters: Optional[list] = None, required_image_parameters: Optional[list] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Helper class that provides a standard way to create an ABC using
inheritance.</p>
<p>Base class for general Python components. Initializes the CommonInterface
and performs configuration validation.</p>
<p>For easier debugging the data folder is picked up by default from <code>../data</code> path,
relative to working directory.</p>
<p>If <code>debug</code> parameter is present in the <code>config.json</code>, the default logger is set to verbose DEBUG mode.</p>
<p>It executes <a href="https://developers.keboola.com/extend/common-interface/actions/">Sync actions</a>
when "action" is defined in the configuration.json based on the @action_decorator.</p>
<h2 id="args">Args</h2>
<p>data_path_override:
optional path to data folder that overrides the default behaviour (<code>KBC_DATADIR</code> environment variable).
May be also specified by '-d' or '–data' commandline argument
required_parameters:
Optional[dict]: DEPRECATED required configuration parameters, if filled in,
validation is done at constructor level
required_image_parameters:
Optional[dict]: DEPRECATED required image parameters, if filled in,
validation is done at constructor level</p>
<h2 id="raises">Raises</h2>
<p>UserException - on config validation errors.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ComponentBase(ABC, CommonInterface):
def __init__(self, data_path_override: Optional[str] = None,
schema_path_override: Optional[str] = None,
required_parameters: Optional[list] = None,
required_image_parameters: Optional[list] = None):
"""
Base class for general Python components. Initializes the CommonInterface
and performs configuration validation.
For easier debugging the data folder is picked up by default from `../data` path,
relative to working directory.
If `debug` parameter is present in the `config.json`, the default logger is set to verbose DEBUG mode.
It executes [Sync actions](https://developers.keboola.com/extend/common-interface/actions/)
when "action" is defined in the configuration.json based on the @action_decorator.
Args:
data_path_override:
optional path to data folder that overrides the default behaviour (`KBC_DATADIR` environment variable).
May be also specified by '-d' or '--data' commandline argument
required_parameters:
Optional[dict]: DEPRECATED required configuration parameters, if filled in,
validation is done at constructor level
required_image_parameters:
Optional[dict]: DEPRECATED required image parameters, if filled in,
validation is done at constructor level
Raises:
UserException - on config validation errors.
"""
# for easier local project setup
super().__init__(data_folder_path=self._get_data_folder_override_path(data_path_override))
if required_parameters:
self.validate_configuration_parameters(required_parameters)
if required_image_parameters:
self.validate_image_parameters(required_image_parameters)
if self.configuration.parameters.get(KEY_DEBUG):
self.set_debug_mode()
self.schema_folder_path = self._get_schema_folder_path(schema_path_override)
@staticmethod
def _get_default_data_path() -> str:
"""
Returns default data_path, by default `../data` is used, relative to working directory.
This helps with local development.
Returns:
"""
return Path(os.getcwd()).resolve().parent.joinpath('data').as_posix()
def _get_data_folder_override_path(self, data_path_override: str = None) -> str:
"""
Returns overridden value of the data_folder_path in case the data_path_override variable
or `KBC_DATADIR` environment variable is defined. The `data_path_override` variable takes precendence.
Returns null if override is not in place.
Args:
data_path_override:
Returns:
"""
data_folder_path = None
if data_path_override:
data_folder_path = data_path_override
elif not os.environ.get('KBC_DATADIR'):
data_folder_path = self._get_default_data_path()
return data_folder_path
def _get_schema_folder_path(self, schema_path_override: str = None) -> str:
"""
Returns value of the schema_folder_path in case the schema_path_override variable is provided or
the default schema_folder_path is found.
"""
return schema_path_override or self._get_default_schema_folder_path()
@staticmethod
def _get_default_schema_folder_path() -> Optional[str]:
"""
Finds the default schema_folder_path if it exists.
"""
container_schema_dir = Path("./src/schemas/").absolute().as_posix()
local_schema_dir = Path("./schemas").absolute().as_posix()
if os.path.isdir(container_schema_dir):
return container_schema_dir
elif os.path.isdir(local_schema_dir):
return local_schema_dir
@staticmethod
def set_debug_mode():
"""
Set the default logger to verbose mode.
Returns:
"""
logging.getLogger().setLevel(logging.DEBUG)
@abstractmethod
def run(self):
"""
Main execution code of default run action.
"""
pass
def execute_action(self):
"""
Executes action defined in the configuration.
The default action is 'run'. See base._SYNC_ACTION_MAPPING
"""
action = self.configuration.action
if not action:
logging.warning("No action defined in the configuration, using the default run action.")
action = 'run'
try:
action = _SYNC_ACTION_MAPPING[action]
action_method = getattr(self, action)
except (AttributeError, KeyError) as e:
raise AttributeError(f"The defined action {action} is not implemented!") from e
return action_method()
def create_out_table_definition_from_schema(self, table_schema: ts.TableSchema, is_sliced: bool = False,
destination: str = '', incremental: bool = None,
enclosure: str = '"', delimiter: str = ',',
delete_where: dict = None) -> dao.TableDefinition:
"""
Creates an out table definition using a defined table schema.
This method uses the given table schema and generates metadata of the table. Along with the additional
key word arguments it creates an out table definition.
Args:
table_schema : table of the schema for which a table definition will be created
is_sliced: True if the full_path points to a folder with sliced tables
destination: String name of the table in Storage.
incremental: Set to true to enable incremental loading
enclosure: str: CSV enclosure, by default "
delimiter: str: CSV delimiter, by default ,
delete_where: Dict with settings for deleting rows
Returns:
TableDefinition object initialized with all table metadata defined in a schema
"""
table_metadata = self._generate_table_metadata(table_schema)
return self.create_out_table_definition(name=table_schema.csv_name,
columns=table_schema.field_names,
primary_key=table_schema.primary_keys,
table_metadata=table_metadata,
is_sliced=is_sliced,
destination=destination,
incremental=incremental,
enclosure=enclosure,
delimiter=delimiter,
delete_where=delete_where)
def get_table_schema_by_name(self, schema_name: str,
schema_folder_path: Optional[str] = None) -> ts.TableSchema:
"""
The method finds a table schema JSON based on it's name in a defined schema_folder_path and generates
a TableSchema object.
Args:
schema_name : name of the schema in the schema_folder_path. e.g. for schema in 'src/schemas/order.json'
schema_name is 'order'
schema_folder_path : directory path to the schema folder, by default the schema folder is set at
'src/schemas'
Returns:
TableSchema object initialized with all available table metadata
"""
if not schema_folder_path:
schema_folder_path = self.schema_folder_path
self._validate_schema_folder_path(schema_folder_path)
schema_dict = self._load_table_schema_dict(schema_name, schema_folder_path)
return ts.init_table_schema_from_dict(schema_dict)
@staticmethod
def _load_table_schema_dict(schema_name: str, schema_folder_path: str) -> Dict:
try:
with open(os.path.join(schema_folder_path, f"{schema_name}.json"), 'r') as schema_file:
json_schema = json.loads(schema_file.read())
except FileNotFoundError as file_err:
raise FileNotFoundError(
f"Schema for corresponding schema name : {schema_name} is not found in the schema directory. "
f"Make sure that '{schema_name}'.json "
f"exists in the directory '{schema_folder_path}'") from file_err
return json_schema
@staticmethod
def _validate_schema_folder_path(schema_folder_path: str):
if not schema_folder_path or not os.path.isdir(schema_folder_path):
raise FileNotFoundError("A schema folder path must be defined in order to create a out table definition "
"from a schema. If a schema folder path is not defined, the schemas folder must be"
" located in the 'src' directory of a component : src/schemas")
def _generate_table_metadata(self, table_schema: ts.TableSchema) -> dao.TableMetadata:
"""
Generates a TableMetadata object for the table definition using a TableSchema object.
"""
table_metadata = dao.TableMetadata()
if table_schema.description:
table_metadata.add_table_description(table_schema.description)
table_metadata.add_column_descriptions({field.name: field.description for field in table_schema.fields})
table_metadata = self._add_field_data_types_to_table_metadata(table_schema, table_metadata)
return table_metadata
@staticmethod
def _add_field_data_types_to_table_metadata(table_schema: ts.TableSchema,
table_metadata: dao.TableMetadata) -> dao.TableMetadata:
"""
Adds data types of all fields specified in a TableSchema object to a given TableMetadata object
"""
for field in table_schema.fields:
if field.base_type:
table_metadata.add_column_data_type(field.name,
data_type=field.base_type,
nullable=field.nullable,
length=field.length,
default=field.default)
return table_metadata</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>abc.ABC</li>
<li><a title="keboola.component.interface.CommonInterface" href="interface.html#keboola.component.interface.CommonInterface">CommonInterface</a></li>
</ul>
<h3>Static methods</h3>
<dl>
<dt id="keboola.component.base.ComponentBase.set_debug_mode"><code class="name flex">
<span>def <span class="ident">set_debug_mode</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Set the default logger to verbose mode.
Returns:</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def set_debug_mode():
"""
Set the default logger to verbose mode.
Returns:
"""
logging.getLogger().setLevel(logging.DEBUG)</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="keboola.component.base.ComponentBase.create_out_table_definition_from_schema"><code class="name flex">
<span>def <span class="ident">create_out_table_definition_from_schema</span></span>(<span>self, table_schema: <a title="keboola.component.table_schema.TableSchema" href="table_schema.html#keboola.component.table_schema.TableSchema">TableSchema</a>, is_sliced: bool = False, destination: str = '', incremental: bool = None, enclosure: str = '"', delimiter: str = ',', delete_where: dict = None) ‑> <a title="keboola.component.dao.TableDefinition" href="dao.html#keboola.component.dao.TableDefinition">TableDefinition</a></span>
</code></dt>
<dd>
<div class="desc"><p>Creates an out table definition using a defined table schema.
This method uses the given table schema and generates metadata of the table. Along with the additional
key word arguments it creates an out table definition.</p>
<h2 id="args">Args</h2>
<dl>
<dt>table_schema : table of the schema for which a table definition will be created</dt>
<dt><strong><code>is_sliced</code></strong></dt>
<dd>True if the full_path points to a folder with sliced tables</dd>
<dt><strong><code>destination</code></strong></dt>
<dd>String name of the table in Storage.</dd>
<dt><strong><code>incremental</code></strong></dt>
<dd>Set to true to enable incremental loading</dd>
<dt><strong><code>enclosure</code></strong></dt>
<dd>str: CSV enclosure, by default "</dd>
<dt><strong><code>delimiter</code></strong></dt>
<dd>str: CSV delimiter, by default ,</dd>
<dt><strong><code>delete_where</code></strong></dt>
<dd>Dict with settings for deleting rows</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>TableDefinition object initialized with all table metadata defined in a schema</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_out_table_definition_from_schema(self, table_schema: ts.TableSchema, is_sliced: bool = False,
destination: str = '', incremental: bool = None,
enclosure: str = '"', delimiter: str = ',',
delete_where: dict = None) -> dao.TableDefinition:
"""
Creates an out table definition using a defined table schema.
This method uses the given table schema and generates metadata of the table. Along with the additional
key word arguments it creates an out table definition.
Args:
table_schema : table of the schema for which a table definition will be created
is_sliced: True if the full_path points to a folder with sliced tables
destination: String name of the table in Storage.
incremental: Set to true to enable incremental loading
enclosure: str: CSV enclosure, by default "
delimiter: str: CSV delimiter, by default ,
delete_where: Dict with settings for deleting rows
Returns:
TableDefinition object initialized with all table metadata defined in a schema
"""
table_metadata = self._generate_table_metadata(table_schema)
return self.create_out_table_definition(name=table_schema.csv_name,
columns=table_schema.field_names,
primary_key=table_schema.primary_keys,
table_metadata=table_metadata,
is_sliced=is_sliced,
destination=destination,
incremental=incremental,
enclosure=enclosure,
delimiter=delimiter,
delete_where=delete_where)</code></pre>
</details>
</dd>
<dt id="keboola.component.base.ComponentBase.execute_action"><code class="name flex">
<span>def <span class="ident">execute_action</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Executes action defined in the configuration.
The default action is 'run'. See base._SYNC_ACTION_MAPPING</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def execute_action(self):
"""
Executes action defined in the configuration.
The default action is 'run'. See base._SYNC_ACTION_MAPPING
"""
action = self.configuration.action
if not action:
logging.warning("No action defined in the configuration, using the default run action.")
action = 'run'
try:
action = _SYNC_ACTION_MAPPING[action]
action_method = getattr(self, action)
except (AttributeError, KeyError) as e:
raise AttributeError(f"The defined action {action} is not implemented!") from e
return action_method()</code></pre>
</details>
</dd>
<dt id="keboola.component.base.ComponentBase.get_table_schema_by_name"><code class="name flex">
<span>def <span class="ident">get_table_schema_by_name</span></span>(<span>self, schema_name: str, schema_folder_path: Optional[str] = None) ‑> <a title="keboola.component.table_schema.TableSchema" href="table_schema.html#keboola.component.table_schema.TableSchema">TableSchema</a></span>
</code></dt>
<dd>
<div class="desc"><p>The method finds a table schema JSON based on it's name in a defined schema_folder_path and generates
a TableSchema object.</p>
<h2 id="args">Args</h2>
<p>schema_name : name of the schema in the schema_folder_path. e.g. for schema in 'src/schemas/order.json'
schema_name is 'order'
schema_folder_path : directory path to the schema folder, by default the schema folder is set at
'src/schemas'</p>
<h2 id="returns">Returns</h2>
<p>TableSchema object initialized with all available table metadata</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_table_schema_by_name(self, schema_name: str,
schema_folder_path: Optional[str] = None) -> ts.TableSchema:
"""
The method finds a table schema JSON based on it's name in a defined schema_folder_path and generates
a TableSchema object.
Args:
schema_name : name of the schema in the schema_folder_path. e.g. for schema in 'src/schemas/order.json'
schema_name is 'order'
schema_folder_path : directory path to the schema folder, by default the schema folder is set at
'src/schemas'
Returns:
TableSchema object initialized with all available table metadata
"""
if not schema_folder_path:
schema_folder_path = self.schema_folder_path
self._validate_schema_folder_path(schema_folder_path)
schema_dict = self._load_table_schema_dict(schema_name, schema_folder_path)
return ts.init_table_schema_from_dict(schema_dict)</code></pre>
</details>
</dd>
<dt id="keboola.component.base.ComponentBase.run"><code class="name flex">
<span>def <span class="ident">run</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Main execution code of default run action.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@abstractmethod
def run(self):
"""
Main execution code of default run action.
"""
pass</code></pre>
</details>
</dd>
</dl>