General module of resources and helpers for printing and making folder trees
27 | in seedir.
28 |
29 |
30 | Expand source code
31 |
32 | # -*- coding: utf-8 -*-
33 | """
34 | General module of resources and helpers for printing and making folder trees
35 | in seedir.
36 |
37 | """
38 |
39 | __pdoc__ = {'is_match': False,
40 | 'format_indent': False,
41 | 'words': False}
42 |
43 |
44 |
45 | import copy
46 | import os
47 | import re
48 |
49 |
50 | STYLE_DICT = {
51 | 'lines': {'split':'├─',
52 | 'extend':'│ ',
53 | 'space':' ',
54 | 'final':'└─',
55 | 'folderstart':'',
56 | 'filestart':'',
57 | 'folderend': '/',
58 | 'fileend': ''},
59 | 'dash': {'split':'|-',
60 | 'extend':'| ',
61 | 'space':' ',
62 | 'final':'|-',
63 | 'folderstart':'',
64 | 'filestart':'',
65 | 'folderend': '/',
66 | 'fileend': ''},
67 | 'spaces':{'split':' ',
68 | 'extend':' ',
69 | 'space':' ',
70 | 'final':' ',
71 | 'folderstart':'',
72 | 'filestart':'',
73 | 'folderend': '/',
74 | 'fileend': ''},
75 | 'plus': {'split':'+-',
76 | 'extend':'| ',
77 | 'space':' ',
78 | 'final':'+-',
79 | 'folderstart':'',
80 | 'filestart':'',
81 | 'folderend': '/',
82 | 'fileend': ''},
83 | 'arrow': {'split':' ',
84 | 'extend':' ',
85 | 'space':' ',
86 | 'final':' ',
87 | 'folderstart':'>',
88 | 'filestart':'>',
89 | 'folderend': '/',
90 | 'fileend': ''}
91 | }
92 | '''"Tokens" used to create folder trees in different styles'''
93 |
94 | try:
95 | import emoji
96 | STYLE_DICT["emoji"] = {
97 | 'split':'├─',
98 | 'extend':'│ ',
99 | 'space':' ',
100 | 'final':'└─',
101 | 'folderstart':emoji.emojize(':file_folder:' + ' '),
102 | 'filestart':emoji.emojize(':page_facing_up:' + ' '),
103 | 'folderend': '/',
104 | 'fileend': ''
105 | }
106 | except ImportError:
107 | pass
108 |
109 |
110 | filepath = os.path.dirname(os.path.abspath(__file__))
111 | wordpath = os.path.join(filepath, 'words.txt')
112 | with open(wordpath, 'r') as wordfile:
113 | words = [line.strip() for line in wordfile.readlines()]
114 | """List of dictionary words for seedir.fakedir.randomdir()"""
115 |
116 | # functions
117 |
118 | def is_match(pattern, string, regex=True):
119 | '''Function for matching strings using either regular expression
120 | or literal interpretation.'''
121 | if regex:
122 | return bool(re.search(pattern, string))
123 | else:
124 | return pattern == string
125 |
126 | def get_styleargs(style):
127 | '''
128 | Return the string tokens associated with different styles for printing
129 | folder trees with `seedir.realdir.seedir()`.
130 |
131 | Parameters
132 | ----------
133 | style : str
134 | Style name. Current options are `'lines'`, `'spaces'`, `'arrow'`,
135 | `'plus'`, `'dash'`, or `'emoji'`.
136 |
137 | Raises
138 | ------
139 | ValueError
140 | Style not recognized.
141 |
142 | ImportError
143 | 'emoji' style requested but emoji package not installed.
144 |
145 | Returns
146 | -------
147 | dict
148 | Dictionary of tokens for the given style.
149 |
150 | '''
151 | if style not in STYLE_DICT and style == 'emoji':
152 | error_text = 'style "emoji" requires "emoji" to be installed'
153 | error_text += ' (pip install emoji) '
154 | raise ImportError(error_text)
155 | elif style not in STYLE_DICT:
156 | error_text = 'style "{}" not recognized, must be '.format(style)
157 | error_text += 'lines, spaces, arrow, plus, dash, or emoji'
158 | raise ValueError(error_text)
159 | else:
160 | return copy.deepcopy(STYLE_DICT[style])
161 |
162 | def format_indent(style_dict, indent=2):
163 | '''
164 | Format the indent of style tokens, from seedir.STYLE_DICT or returned
165 | by seedir.get_styleargs().
166 |
167 | Note that as of v0.3.1, the dictionary is modified in place,
168 | rather than a new copy being created.
169 |
170 | Parameters
171 | ----------
172 | style_dict : dict
173 | Dictionary of style tokens.
174 | indent : int, optional
175 | Number of spaces to indent. The default is 2. With 0, all tokens
176 | become the null string. With 1, all tokens are only the first
177 | character. With 2, the style tokens are returned unedited. When >2,
178 | the final character of each token (excep the file/folder start/end tokens)
179 | are extened n - indent times, to give a string whose
180 | length is equal to indent.
181 |
182 | Returns
183 | -------
184 | output : dict
185 | New dictionary of edited tokens.
186 |
187 | '''
188 | indentable = ['split', 'extend', 'space', 'final']
189 | if indent < 0 or not isinstance(indent, int):
190 | raise ValueError('indent must be a non-negative integer')
191 | elif indent == 0:
192 | for key in indentable:
193 | style_dict[key] = ''
194 | elif indent == 1:
195 | for key in indentable:
196 | style_dict[key] = style_dict[key][0]
197 | elif indent > 2:
198 | extension = indent - 2
199 | for key in indentable:
200 | val = style_dict[key]
201 | style_dict[key] = val + val[-1] * extension
202 |
203 | return None
204 |
205 |