Source.Python/docs/_modules/core/table.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

History

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

<!DOCTYPE html>

<head>

<title>core.table — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">core.table</a></li>

</ul>

</div>

<h1>Source code for core.table</h1><div class="highlight"><pre>

# ../core/table.py

"""Provides an object oriented way to print out tables."""

# =============================================================================

# >> IMPORTS

# =============================================================================

# Python Imports

# Enum

from enum import Enum

# Itertools

from itertools import zip_longest

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('Alignment',

'AsciiTable',

'Column',

'Item',

)

# =============================================================================

# >> CLASSES

# =============================================================================

class Alignment(Enum):

"""Contains constants to specify the aligment of table items."""

LEFT = str.ljust

RIGHT = str.rjust

CENTER = str.center</div>

class Column(list):

"""Represents a column of a table."""

def __init__(

self, name, alignment=Alignment.CENTER,

left_padding=2, right_padding=2):

"""Intialize the column.

:param str name: Name of the column.

:param int alignment: The alignment of the column name.

:param int left_padding: Number of spaces for left padding.

:param int right_padding: Number of spaces for right padding.

"""

super().__init__()

self.name = Item(name, alignment)

self.left_padding = left_padding

self.right_padding = right_padding</div>

def _get_max_padding(self):

"""Return the length of the longest item in the column.

The name of the column is used to determine the length, as well.

"""

length = len(self.name)

if not self:

return length

return max(len(max(self, key=len)), length)

def _format(self):

"""Return the name of the column and all items of the column.

All items (including the name) will be

formatted properly before being returned.

"""

padding = self._get_max_padding()

return (self.name._format(

padding, self.left_padding, self.right_padding), tuple(

item._format(padding, self.left_padding, self.right_padding)

for item in self))</div>

class Item(object):

"""Represents a value/item of a column."""

def __init__(self, value, alignment=Alignment.LEFT):

"""Initialize the item.

:param value: The value this item should have.

:param int aligment: The aligment of the item in the table.

"""

self.value = str(value)

self.alignment = alignment</div>

def __len__(self):

"""Return the length of the value."""

return len(self.value)

def _format(self, padding, left_padding, right_padding):

"""Format the item.

:param int padding: The length of the longest item in the column.

:param int left_padding: A number that defines how many spaces should

be added to the left of the item.

:param int right_padding: A number that defines how many spaces should

be added to the right of the item.

"""

return '{0}{1}{2}'.format(

' ' * left_padding, self.alignment(self.value, padding),

' ' * right_padding)</div>

class AsciiTable(object):

"""Represents a table."""

"""Add the given objects as columns to the table.

If a given column is not a Column object, it will be created.

"""

if len(columns) == 0:

raise ValueError('Table must have at least one column.')

self._columns = []

for column in columns:

if not isinstance(column, Column):

column = Column(column)

self._columns.append(column)</div>

def __len__(self):

"""Return the number of columns."""

return len(self._columns)

def __iter__(self):

"""Return an iterator for all columns."""

return iter(self._columns)

def __getitem__(self, index):

"""Return the column at the given index."""

return self._columns[index]

def add_row(self, *items):

"""Append the given items to the table's columns."""

if len(items) != len(self):

raise ValueError(

'You must add exactly the same number of items' +

' like the number of columns.')

for index, item in enumerate(items):

if not isinstance(item, Item):

item = Item(item)

self[index].append(item)</div>

def format(self, header_separator='=', column_separator='|'):

"""Format the table and returns an ASCII table string.

:param str header_separator: A single character that defines the

character that should be used to create the horizontal separator.

:param str column_separator: A single character that defines the

character that should be used to create the vertical separators.

"""

if not isinstance(header_separator, str) or len(header_separator) != 1:

raise ValueError('Header separator must be a single character.')

columns = []

rows = []

for column in self:

column, row = column._format()

columns.append(column)

rows.append(row)

header = column_separator.join(columns)

return '{0}\n{1}\n{2}'.format(

header,

header_separator * len(header),

'\n'.join(column_separator.join(row) for row in zip_longest(

*rows, fillvalue='')))</div>

</div>

</pre></div>

</div>

</a>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">core.table</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Source.Python/docs/_modules/core/table.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

table.html

Latest commit

History

Breadcrumbs

table.html

File metadata and controls