-
Notifications
You must be signed in to change notification settings - Fork 6
/
pjutils.py
467 lines (334 loc) · 13.3 KB
/
pjutils.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
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
# -*- coding: utf-8 -*-
from __future__ import absolute_import
import argparse
import subprocess
import os
import errno
import getpass
import re
import codecs
import shutil
import platform
"""Utils prepared for makefile
This module will include:
sphinx
offline distribution
...
Example:
None
Attributes:
module_level_variable (int): description
"""
here = os.path.abspath(os.path.dirname(__file__))
# folder
DOC_FOLDER = 'docs'
HTML_FOLDER = os.path.join(DOC_FOLDER, 'html')
DEP_FOLDER = 'deps'
MAC_DEP_FOLDER = os.path.join(DEP_FOLDER, 'macosx')
LINUX_DEP_FOLDER = os.path.join(DEP_FOLDER, 'linux')
SRC_FOLDER = 'src'
PROJECT_NAME = 'secret_miner'
WORK_DIR_ABPATH = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
os.chdir(WORK_DIR_ABPATH)
# system
CURRENT_SYSTEM = platform.system()
def mkdir_exist(directory):
"""TODO: Docstring for mkdir_exist.
Args:
directory (str): TODO
"""
if not os.path.exists(directory):
try:
os.makedirs(directory)
except OSError as e:
if e.errno != errno.EEXIST:
raise
class Editor(object):
"""an editor used regex to replace certain lines """
def __init__(self, fpath):
"""TODO: to be defined1. """
self._fpath = fpath
self._swp_lines = []
# unit test mock doesn't support `for line in f`
with open(fpath) as f:
self._swp_lines = [s.rstrip() for s in f.read().splitlines()]
@property
def fpath(self):
return self._fpath
def editline_with_regex(self, regex_tgtline, to_replace):
"""find the first matched line, then replace
Args:
regex_tgtline (str): regular expression used to match the target line
to_replace (str): line you wanna use to replace
"""
for idx, line in enumerate(self._swp_lines):
mobj = re.match(regex_tgtline, line)
if mobj:
self._swp_lines[idx] = to_replace
return
def finish_writing(self):
content = list(map(lambda x: x + '\n', self._swp_lines))
with open(self.fpath, 'w') as f:
f.write(''.join(content))
class ProjectInfo(object):
"""Common information for the project"""
def __init__(self, **kwinfo):
"""init project info
Args:
author_fakename (str): TODO
author_truename (str): TODO
email (str): TODO
project_name (str): TODO
project_version (str): TODO
"""
self._author_fakename = getpass.getuser()
self._author_truename = ProjectInfo.find_pakcage_info(
'author', SRC_FOLDER, PROJECT_NAME, '__init__.py')
self._email = ProjectInfo.find_pakcage_info(
'email', SRC_FOLDER, PROJECT_NAME, '__init__.py')
self._project_name = os.path.basename(
os.path.dirname(os.path.realpath(__file__)))
self._project_version = ProjectInfo.find_pakcage_info(
'version', SRC_FOLDER, PROJECT_NAME, '__init__.py')
for key, info in kwinfo.items():
key = '_' + key
setattr(self, key, info)
@property
def author_fakename(self):
return self._author_fakename
@property
def author_truename(self):
return self._author_truename
@property
def email(self):
return self._email
@property
def project_name(self):
return self._project_name
@property
def project_version(self):
return self._project_version
@classmethod
def _read(cls, *parts):
with codecs.open(os.path.join(here, *parts), 'r') as fp:
return fp.read()
@classmethod
def find_pakcage_info(cls, info, *file_paths):
info_file = ProjectInfo._read(*file_paths)
match = re.search(
r"^__" + re.escape(info) + r"__ = ['\"]([^'\"]*)['\"]", info_file,
re.M)
if match:
return match.group(1)
raise RuntimeError("Unable to find {} string.".format(info))
proj_info = ProjectInfo()
author_fakename = proj_info.author_fakename
author_truename = proj_info.author_truename
email = proj_info.email
project_name = proj_info.project_name
project_version = proj_info.project_version
########################################################################################################################
# exceptions #
########################################################################################################################
class PJUtilsError(Exception):
"""Base pjutils exception"""
class PlatformNotSupportedError(PJUtilsError):
"""General exception in PyOfflineDist"""
class PythonVersionNotSupportedError(PJUtilsError):
"""General exception in PyOfflineDist"""
########################################################################################################################
# sphinx #
########################################################################################################################
class Sphinx(object):
"""Docstring for Sphinx. """
def __init__(self, proj_info):
"""TODO: to be defined1.
Args:
proj_info (ProjectInfo): TODO
"""
self._proj_info = proj_info
self.__docfolder = DOC_FOLDER
self.__htmlfolder = HTML_FOLDER
self.conf_fpath = os.path.abspath(
os.path.join(self.__docfolder, 'conf.py'))
self.code_fdpath = os.path.abspath(
os.path.join(SRC_FOLDER, self.proj_info.project_name))
self._sphinx_quickstart_cmd = [
'sphinx-quickstart', self.__docfolder, '-p',
self.proj_info.project_name, '-a', self.proj_info.author_fakename,
'-v', self.proj_info.project_version, '-r',
self.proj_info.project_version, '-l', 'en', '--ext-autodoc',
'--makefile', '--quiet'
]
self._sphinx_apidoc_cmd = [
'sphinx-apidoc', self.code_fdpath, '-o', self.__docfolder, '-M',
'--force'
]
# sphinx-build -b html docs html
self._sphinx_buildhtml_cmd = [
'sphinx-build', '-b', 'html', self.__docfolder, self.__htmlfolder
]
# make sure directories exist
mkdir_exist(self.__docfolder)
mkdir_exist(self.__htmlfolder)
@property
def proj_info(self):
return self._proj_info
@property
def sphinx_quickstart_cmd(self):
return self._sphinx_quickstart_cmd
def quickstart(self):
"""TODO: Docstring for quickstart. """
subprocess.call(self.sphinx_quickstart_cmd)
pass
def gen_code_api(self):
"""TODO: Docstring for gen_code_api."""
# edit config file
conf_editor = Editor(self.conf_fpath)
# insert code path for searching
conf_editor.editline_with_regex(r'^# import os', 'import os')
conf_editor.editline_with_regex(r'^# import sys', 'import sys')
conf_editor.editline_with_regex(
r'^# sys\.path\.insert',
'sys.path.insert(0, "{}")'.format(self.code_fdpath))
conf_editor.editline_with_regex(
r"""html_theme = 'alabaster'""",
'html_theme = \'default\''.format(self.code_fdpath))
conf_editor.finish_writing()
# sphinx-apidoc to generate rst from source code
# force regenerate
subprocess.call(self._sphinx_apidoc_cmd)
pass
def rst2html(self):
subprocess.call(self._sphinx_buildhtml_cmd)
pass
########################################################################################################################
# offline distribution #
########################################################################################################################
class PyOfflineDist(object):
"""offline distribution for python project"""
def __init__(self, req_fpath='requirements.txt'):
"""TODO: to be defined1. """
self.__dep_folder = DEP_FOLDER
self.__req_fpath = req_fpath
self._srcpj_abfdpath = os.path.abspath(
os.path.join(SRC_FOLDER, PROJECT_NAME))
pass
def freeze_deps(self):
with open(self.__req_fpath, 'w') as f:
self._freeze_deps_cmd = ['pip', 'freeze']
p = subprocess.Popen(self._freeze_deps_cmd, stdout=f)
p.wait()
pass
def __get_dep_folder(self):
if CURRENT_SYSTEM == 'Darwin':
self.__dep_folder = os.path.join(DEP_FOLDER, 'macosx')
elif CURRENT_SYSTEM == 'Linux':
self.__dep_folder = os.path.join(DEP_FOLDER, 'linux')
else:
raise PlatformNotSupportedError('only support for mac or linux')
def download_deps(self):
self.__get_dep_folder()
mkdir_exist(self.__dep_folder)
self._download_deps_cmd = [
'pip', 'download', '-r', self.__req_fpath, '-d', self.__dep_folder
]
subprocess.call(self._download_deps_cmd)
def install_deps(self):
self.__get_dep_folder()
self._install_deps_cmd = [
'pip', 'install', '--no-index', '--find-links', self.__dep_folder,
'-r', self.__req_fpath
]
subprocess.call(self._install_deps_cmd)
def clean_deps(self):
self.__get_dep_folder()
shutil.rmtree(self.__dep_folder, ignore_errors=True)
def pyinstaller_mkbinary(self, script_name):
self._pyinstaller_mkbinary_cmd = [
'pyinstaller', '--onefile', script_name
]
# enter the source code directory
os.chdir(self._srcpj_abfdpath)
# execute pyinstaller
# generate dist and build folders
subprocess.call(self._pyinstaller_mkbinary_cmd)
# return to previous directory
os.chdir(WORK_DIR_ABPATH)
pass
def clean_binary(self):
# enter the source code directory
os.chdir(self._srcpj_abfdpath)
shutil.rmtree('dist', ignore_errors=True)
shutil.rmtree('build', ignore_errors=True)
# return to previous directory
os.chdir(WORK_DIR_ABPATH)
pass
########################################################################################################################
# Commandline Interface #
########################################################################################################################
def add_subcommands(subparsers):
# sphinx
parser_sphinx = subparsers.add_parser('sphinx', help='sphinx help')
parser_sphinx.add_argument('--quickstart', action='store_true')
parser_sphinx.add_argument('--gen-code-api', action='store_true')
parser_sphinx.add_argument('--rst2html', action='store_true')
# offline_dist
parser_offline_dist = subparsers.add_parser(
'offline_dist', help='offline_dist help')
parser_offline_dist.add_argument('--freeze-deps', action='store_true')
parser_offline_dist.add_argument('--download-deps', action='store_true')
parser_offline_dist.add_argument('--install-deps', action='store_true')
parser_offline_dist.add_argument('--clean-deps', action='store_true')
parser_offline_dist.add_argument('--mkbinary')
parser_offline_dist.add_argument('--clean-binary', action='store_true')
# subparsers_offline_dist = parser_offline_dist.add_subparsers(dest='offline_dist_command')
#
# parser_download = subparsers_offline_dist.add_parser('download')
# parser_install = subparsers_offline_dist.add_parser('install')
# parser_mkbinary = subparsers_offline_dist.add_parser('mkbinary')
# download
# parser_download.add_argument('--platform', action='store', choices=['macosx-10_10_x86_64', 'linux_x86_64'])
# parser_download.add_argument('--python-version', action='store', choices=['27', '3'])
# install
# mkbinary
pass
def execute_by_options(args):
"""execute by argument dictionary
Args:
args (dict): command line argument dictionary
"""
if args['subcommand'] == 'sphinx':
s = Sphinx(proj_info)
if args['quickstart']:
s.quickstart()
elif args['gen_code_api']:
s.gen_code_api()
elif args['rst2html']:
s.rst2html()
pass
elif args['subcommand'] == 'offline_dist':
pod = PyOfflineDist()
if args['freeze_deps']:
pod.freeze_deps()
elif args['download_deps']:
pod.download_deps()
elif args['install_deps']:
pod.install_deps()
elif args['clean_deps']:
pod.clean_deps()
elif args['mkbinary']:
pod.pyinstaller_mkbinary(args['mkbinary'])
elif args['clean_binary']:
pod.clean_binary()
pass
def main():
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(
help='sub-command help', dest='subcommand')
add_subcommands(subparsers)
args = vars(parser.parse_args())
execute_by_options(args)
# if args['sphinx'] ==
if __name__ == '__main__':
main()