Importing
cibmangotree.importing
¶
Modules:
| Name | Description |
|---|---|
csv |
|
excel |
|
importer |
|
Classes¶
Modules¶
csv
¶
Classes:
| Name | Description |
|---|---|
CSVImporter |
|
Classes¶
CSVImporter
¶
Bases: Importer['CsvImportSession']
Source code in src/cibmangotree/importing/csv.py
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 | |
excel
¶
Classes:
| Name | Description |
|---|---|
ExcelImporter |
|
Classes¶
ExcelImporter
¶
Bases: Importer['ExcelImportSession']
Methods:
| Name | Description |
|---|---|
init_session |
Initialize Excel import session. |
Source code in src/cibmangotree/importing/excel.py
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 | |
init_session(input_path)
¶Initialize Excel import session.
For single-sheet files, automatically selects the sheet. For multi-sheet files, returns None (caller must provide sheet selection).
Source code in src/cibmangotree/importing/excel.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | |
importer
¶
Classes:
| Name | Description |
|---|---|
Importer |
|
ImporterSession |
The ImporterSession interface handles the ongoing configuration of an import. |
Classes¶
Importer
¶
Bases: ABC
Methods:
| Name | Description |
|---|---|
init_session |
Produces an initial import session object that contains all the configuration |
suggest |
Check if the importer can handle the given file. This should be fairly |
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the importer. It will be quoted in the UI in texts such as |
Source code in src/cibmangotree/importing/importer.py
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 | |
name
abstractmethod
property
¶The name of the importer. It will be quoted in the UI in texts such as
"Imported as name, so keep it to a format name."
init_session(input_path)
abstractmethod
¶Produces an initial import session object that contains all the configuration needed for the import. The user can either accept this configuration or customize it.
Return None here if the importer cannot figure out how to configure the import parameters. This doesn't necessarily mean that the file cannot be loaded; the UI will force the user to customize the import session if the user wants to proceed with this importer.
Source code in src/cibmangotree/importing/importer.py
54 55 56 57 58 59 60 61 62 63 64 65 66 | |
suggest(input_path)
abstractmethod
¶Check if the importer can handle the given file. This should be fairly restrictive based on reasonable assumptions, as it is only used for the initial importer suggestion. The user can always override the suggestion.
Source code in src/cibmangotree/importing/importer.py
45 46 47 48 49 50 51 52 | |
ImporterSession
¶
Bases: ABC
The ImporterSession interface handles the ongoing configuration of an import. It keeps the configuration state and can load a preview of the data from the input file.
Methods:
| Name | Description |
|---|---|
import_as_parquet |
Import the data from the input file to the output file in the Parquet format. |
load_preview |
Attempt to load a preview of the data from the input file. |
Source code in src/cibmangotree/importing/importer.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | |
import_as_parquet(output_path)
abstractmethod
¶Import the data from the input file to the output file in the Parquet format.
Source code in src/cibmangotree/importing/importer.py
24 25 26 27 28 29 | |
load_preview(n_records)
abstractmethod
¶Attempt to load a preview of the data from the input file.
Return None here if it is sure that the file cannot be loaded with the current configuration. Only throw an execption in the case of unexpected errors.
Source code in src/cibmangotree/importing/importer.py
14 15 16 17 18 19 20 21 22 | |