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
|
###############################################################################
#
# file: __init__.py
#
# Purpose: refer to python doc for documentation details.
#
# Note: This file is part of Termsaver application, and should not be used
# or executed separately.
#
###############################################################################
#
# Copyright 2012 Termsaver
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
###############################################################################
"""
This module itself holds simple functions to better handle the screens
available within this package. Available functions:
* `get_available_screens`: Gets the available screens in this package for
dynamic instantiation.
* `build_screen_usage_list`: Builds a simple string with a list of all
available screens, to be used in usage() methods.
The modules available in this package are:
* `asciiartfarts`: displays ascii images from asciiartfarts.com
* `dot`: displays a random running dot
* `jokes4all`: displays recent jokes from jokes4all.net
* `programmer`: displays source code in typing animation
* `quotes4all`: displays recent quotes from quotes4all.net
* `randtxt`: displays word in random places on screen
* `rfc`: randomly displays RFC contents
* `rssfeed`: displays rss feed information
* `urlfetcher`: displays url contents with typing animation
This also contains the following sub-packages:
* `base`: holds base classes that are used by all screens within termsaver
application
* `helper`: holds all helper classes used by termsaver screens, to add
reusable functionality to them
"""
#
# Python built-in modules
#
import os
import inspect
#
# Internal modules
#
from termsaverlib.screen import base
def get_available_screens():
"""
Gets the available screens in this package for dynamic instantiation.
"""
ignore_list = ['__init__.py']
screens = []
for module in os.listdir(os.path.join(os.path.dirname(__file__))):
if module in ignore_list or module[-3:] != '.py':
continue
module_name = module[:-3]
m = __import__(module_name, globals(), locals())
# loop module's classes in search for the ones inheriting Screenbase
# and ignore name (no need) with underscore variable
for name, obj in inspect.getmembers(m):
if inspect.isclass(obj) and issubclass(obj, base.ScreenBase) \
and not name.endswith("Base"):
screens.append(obj)
return screens
def build_screen_usage_list():
"""
Builds a simple string with a list of all available screens,
to be used in usage() methods.
"""
screens = get_available_screens()
screen_space = max([len(s().name) for s in screens])
return '\n '.join([''.join([s().name, ' ',
' ' * (screen_space - len(s().name) + 1),
s().description]) for s in get_available_screens()])
|
