/
lbsntransform_.py
181 lines (160 loc) · 6.64 KB
/
lbsntransform_.py
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
# -*- coding: utf-8 -*-
"""
LBSNTransform: Convert Raw Social Media data
to common LBSN interchange format (ProtoBuf) and
transfer to local CSV or LBSN Postgres Database
"""
from __future__ import absolute_import
__author__ = "Alexander Dunkel"
__license__ = "GNU GPLv3"
import io
import logging
import sys
from pathlib import Path
from .tools.helper_functions import HelperFunctions as HF
from .output.shared_structure import LBSNRecordDicts
from .output.submit_data import LBSNTransfer
from .input.load_data import LoadData
class LBSNTransform():
"""Import, convert and export RAW Location Based Social Media data,
such as Twitter and Flickr, based on a common data structure concept
in Google's ProtoBuf format (see package lbsnstructure).
Input can be:
- local CSV or Json (stacked/regular/line separated)
- Postgres DB connection
Output can be:
- local CSV
- local file with ProtoBuf encoded records
- local SQL file ready for "Import from" in Postgres LBSN db
- Postgres DB connection (with existing LBSN DB Structure)
Parameters
----------
origin_id : int, optional (default=3)
Type of input source. Each input source has its own import mapper
defined in a class. Feel free to add or modify classes based
on your needs. Pre-provided are:
2 - Flickr
2.1 - Flickr YFCC100M dataset
3 - Twitter
"""
def __init__(
self, importer, logging_level=None,
is_local_input: bool = False, transfer_count: int = 50000,
csv_output: bool = True, csv_suppress_linebreaks: bool = True,
dbuser_output=None, dbserveraddress_output=None, dbname_output=None,
dbpassword_output=None, dbserverport_output=None,
dbuser_input=None, dbserveraddress_input=None, dbname_input=None,
dbpassword_input=None, dbserverport_input=None,
dbformat_output=None, dbuser_hllworker=None,
dbserveraddress_hllworker=None, dbname_hllworker=None,
dbpassword_hllworker=None, dbserverport_hllworker=None,
include_lbsn_bases=None):
"""Init settings for LBSNTransform"""
# init logger level
if logging_level is None:
logging_level = logging.INFO
# Set Output to Replace in case of encoding issues (console/windows)
sys.stdout = io.TextIOWrapper(
sys.stdout.detach(), sys.stdout.encoding, 'replace')
sys.stdout.flush()
self.log = HF.set_logger()
# init global settings
self.transfer_count = transfer_count
self.importer = importer
# get origin name and id from importer
# e.g. yfcc100m dataset has origin id 21,
# but is specified as general Flickr origin (2) in importer
self.origin_id = self.importer.ORIGIN_ID
self.origin_name = self.importer.ORIGIN_NAME
# establish output connection
self.dbuser_output = dbuser_output
conn_output, cursor_output = LoadData.initialize_connection(
dbuser_output, dbserveraddress_output,
dbname_output, dbpassword_output, dbserverport_output)
if dbformat_output == "hll":
__, cursor_hllworker = LoadData.initialize_connection(
dbuser_hllworker, dbserveraddress_hllworker,
dbname_hllworker, dbpassword_hllworker, dbserverport_hllworker,
readonly=True)
else:
cursor_hllworker = None
# store global for closing connection later
self.cursor_output = cursor_output
self.output = LBSNTransfer(
db_cursor=cursor_output,
db_connection=conn_output,
store_csv=csv_output,
SUPPRESS_LINEBREAKS=csv_suppress_linebreaks,
dbformat_output=dbformat_output,
hllworker_cursor=cursor_hllworker,
include_lbsn_bases=include_lbsn_bases)
# load from local json/csv or from PostgresDB
self.cursor_input = None
self.is_local_input = is_local_input
if not self.is_local_input:
__, cursor_input = LoadData.initialize_connection(
dbuser_input, dbserveraddress_input,
dbname_input, dbpassword_input, dbserverport_input,
readonly=True, dict_cursor=True)
self.cursor_input = cursor_input
# loc_filelist = LoadData.read_local_files(config)
# else:
# # establish input connection
#
# initialize stats
self.processed_total = 0
self.initial_loop = True
self.how_long = None
# field mapping structure
# this is where all the converted data will be stored
# note that one input record may contain many lbsn records
self.lbsn_records = LBSNRecordDicts()
def add_processed_records(self, lbsn_record):
"""Adds one or multiple LBSN Records (ProtoBuf)
to collection (dicts of LBSNRecords)
Will automatically call self.store_lbsn_records()
"""
self.lbsn_records.add_records_to_dict(
lbsn_record)
self.processed_total += 1
# On the first loop
# or after 50.000 (default) processed records,
# store results
if self.initial_loop:
if self.output.dbformat_output == 'lbsn':
self.output.store_origin(
self.origin_id, self.origin_name)
self.store_lbsn_records()
self.initial_loop = False
if self.lbsn_records.count_glob >= self.transfer_count:
print("\n", end='')
self.store_lbsn_records()
def store_lbsn_records(self):
"""Stores processed LBSN Records to chosen outpur format
"""
self.output.store_lbsn_record_dicts(self.lbsn_records)
self.output.commit_changes()
self.lbsn_records.clear()
def finalize_output(self):
"""finalize all transactions (csv merge etc.)
"""
self.store_lbsn_records()
self.output.finalize()
# Close connections to DBs
if not self.is_local_input:
self.cursor_input.close()
if self.dbuser_output:
self.cursor_output.close()
@staticmethod
def close_log():
""""Closes log and writes to archive file
"""
logging.shutdown()
# rename log file for archive purposes
today = HF.get_str_formatted_today()
outfile = Path(f"{today}.log")
with open(outfile, 'a+') as outfile:
with open('log.log') as infile:
outfile.write(f'\n')
for line in infile:
outfile.write(line)