root / snf-django-lib / snf_django / management / commands / __init__.py @ 3b6afb38
History | View | Annotate | Download (11.9 kB)
1 | 7cfc0cef | Christos Stavrakakis | # Copyright 2012-2013 GRNET S.A. All rights reserved.
|
---|---|---|---|
2 | 7cfc0cef | Christos Stavrakakis | #
|
3 | 7cfc0cef | Christos Stavrakakis | # Redistribution and use in source and binary forms, with or
|
4 | 7cfc0cef | Christos Stavrakakis | # without modification, are permitted provided that the following
|
5 | 7cfc0cef | Christos Stavrakakis | # conditions are met:
|
6 | 7cfc0cef | Christos Stavrakakis | #
|
7 | 7cfc0cef | Christos Stavrakakis | # 1. Redistributions of source code must retain the above
|
8 | 7cfc0cef | Christos Stavrakakis | # copyright notice, this list of conditions and the following
|
9 | 7cfc0cef | Christos Stavrakakis | # disclaimer.
|
10 | 7cfc0cef | Christos Stavrakakis | #
|
11 | 7cfc0cef | Christos Stavrakakis | # 2. Redistributions in binary form must reproduce the above
|
12 | 7cfc0cef | Christos Stavrakakis | # copyright notice, this list of conditions and the following
|
13 | 7cfc0cef | Christos Stavrakakis | # disclaimer in the documentation and/or other materials
|
14 | 7cfc0cef | Christos Stavrakakis | # provided with the distribution.
|
15 | 7cfc0cef | Christos Stavrakakis | #
|
16 | 7cfc0cef | Christos Stavrakakis | # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 | 7cfc0cef | Christos Stavrakakis | # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 | 7cfc0cef | Christos Stavrakakis | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 | 7cfc0cef | Christos Stavrakakis | # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 | 7cfc0cef | Christos Stavrakakis | # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 | 7cfc0cef | Christos Stavrakakis | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 | 7cfc0cef | Christos Stavrakakis | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 | 7cfc0cef | Christos Stavrakakis | # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 | 7cfc0cef | Christos Stavrakakis | # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 | 7cfc0cef | Christos Stavrakakis | # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 | 7cfc0cef | Christos Stavrakakis | # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 | 7cfc0cef | Christos Stavrakakis | # POSSIBILITY OF SUCH DAMAGE.
|
28 | 7cfc0cef | Christos Stavrakakis | #
|
29 | 7cfc0cef | Christos Stavrakakis | # The views and conclusions contained in the software and
|
30 | 7cfc0cef | Christos Stavrakakis | # documentation are those of the authors and should not be
|
31 | 7cfc0cef | Christos Stavrakakis | # interpreted as representing official policies, either expressed
|
32 | 7cfc0cef | Christos Stavrakakis | # or implied, of GRNET S.A.
|
33 | 7cfc0cef | Christos Stavrakakis | |
34 | 7cfc0cef | Christos Stavrakakis | from optparse import make_option |
35 | 7cfc0cef | Christos Stavrakakis | |
36 | 7cfc0cef | Christos Stavrakakis | from django.core.management.base import BaseCommand, CommandError |
37 | 7cfc0cef | Christos Stavrakakis | from django.core.exceptions import FieldError |
38 | 7cfc0cef | Christos Stavrakakis | |
39 | 7cfc0cef | Christos Stavrakakis | from snf_django.management import utils |
40 | 7cfc0cef | Christos Stavrakakis | from snf_django.lib.astakos import UserCache |
41 | 7cfc0cef | Christos Stavrakakis | |
42 | 7cfc0cef | Christos Stavrakakis | |
43 | 7cfc0cef | Christos Stavrakakis | class SynnefoCommand(BaseCommand): |
44 | 7cfc0cef | Christos Stavrakakis | option_list = BaseCommand.option_list + ( |
45 | 7cfc0cef | Christos Stavrakakis | make_option( |
46 | 7cfc0cef | Christos Stavrakakis | "--output-format",
|
47 | 7cfc0cef | Christos Stavrakakis | dest="output_format",
|
48 | 7cfc0cef | Christos Stavrakakis | metavar="[pretty, csv, json]",
|
49 | 7cfc0cef | Christos Stavrakakis | default="pretty",
|
50 | 7cfc0cef | Christos Stavrakakis | choices=["pretty", "csv", "json"], |
51 | 7cfc0cef | Christos Stavrakakis | help="Select the output format: pretty [the default], tabs"
|
52 | 7cfc0cef | Christos Stavrakakis | " [tab-separated output], csv [comma-separated output]"),
|
53 | 7cfc0cef | Christos Stavrakakis | ) |
54 | 7cfc0cef | Christos Stavrakakis | |
55 | 7cfc0cef | Christos Stavrakakis | |
56 | 7cfc0cef | Christos Stavrakakis | class ListCommand(BaseCommand): |
57 | 7cfc0cef | Christos Stavrakakis | """Generic *-list management command.
|
58 | 7cfc0cef | Christos Stavrakakis |
|
59 | 7cfc0cef | Christos Stavrakakis | Management command to handle common tasks when implementing a -list
|
60 | 7cfc0cef | Christos Stavrakakis | management command. This class handles the following tasks:
|
61 | 7cfc0cef | Christos Stavrakakis |
|
62 | 7cfc0cef | Christos Stavrakakis | * Retrieving objects from database.
|
63 | 7cfc0cef | Christos Stavrakakis |
|
64 | 7cfc0cef | Christos Stavrakakis | The DB model class is declared in ``object_class`` class attribute. Also,
|
65 | 7cfc0cef | Christos Stavrakakis | results can be filter using either the ``filters`` and ``excludes``
|
66 | 7cfc0cef | Christos Stavrakakis | attribute or the "--filter-by" option.
|
67 | 7cfc0cef | Christos Stavrakakis |
|
68 | 7cfc0cef | Christos Stavrakakis | * Display specific fields of the database objects.
|
69 | 7cfc0cef | Christos Stavrakakis |
|
70 | 7cfc0cef | Christos Stavrakakis | List of available fields is defined in the ``FIELDS`` class attribute,
|
71 | 7cfc0cef | Christos Stavrakakis | which is a dictionary mapping from field names to tuples containing the
|
72 | 7cfc0cef | Christos Stavrakakis | way the field is retrieved and a text help message to display. The first
|
73 | 7cfc0cef | Christos Stavrakakis | field of the tuple is either a string containing a chain of attribute
|
74 | 7cfc0cef | Christos Stavrakakis | accesses (e.g. "machine.flavor.cpu") either a callable function, taking
|
75 | 7cfc0cef | Christos Stavrakakis | as argument the DB object and returning a single value.
|
76 | 7cfc0cef | Christos Stavrakakis |
|
77 | 7cfc0cef | Christos Stavrakakis | The fields that will be displayed be default is contained in the ``fields``
|
78 | 7cfc0cef | Christos Stavrakakis | class attribute. The user can specify different fields using the "--fields"
|
79 | 7cfc0cef | Christos Stavrakakis | option.
|
80 | 7cfc0cef | Christos Stavrakakis |
|
81 | 7cfc0cef | Christos Stavrakakis | * Handling of user UUIDs and names.
|
82 | 7cfc0cef | Christos Stavrakakis |
|
83 | 7cfc0cef | Christos Stavrakakis | If the ``user_uuid_field`` is declared, then "--user" and "--display-mails"
|
84 | 7cfc0cef | Christos Stavrakakis | options will become available. The first one allows filtering via either
|
85 | 7cfc0cef | Christos Stavrakakis | a user's UUID or display name. The "--displayname" option will append
|
86 | 7cfc0cef | Christos Stavrakakis | the displayname of ther user with "user_uuid_field" to the output.
|
87 | 7cfc0cef | Christos Stavrakakis |
|
88 | 7cfc0cef | Christos Stavrakakis | * Pretty printing output to a nice table.
|
89 | 7cfc0cef | Christos Stavrakakis |
|
90 | 7cfc0cef | Christos Stavrakakis | """
|
91 | 7cfc0cef | Christos Stavrakakis | |
92 | 7cfc0cef | Christos Stavrakakis | # The following fields must be handled in the ListCommand subclasses!
|
93 | 7cfc0cef | Christos Stavrakakis | |
94 | 7cfc0cef | Christos Stavrakakis | # The django DB model
|
95 | 7cfc0cef | Christos Stavrakakis | object_class = None
|
96 | 7cfc0cef | Christos Stavrakakis | # The name of the field containg the user ID of the user, if any.
|
97 | 7cfc0cef | Christos Stavrakakis | user_uuid_field = None
|
98 | 7cfc0cef | Christos Stavrakakis | # The name of the field containg the deleted flag, if any.
|
99 | 7cfc0cef | Christos Stavrakakis | deleted_field = None
|
100 | 7cfc0cef | Christos Stavrakakis | # Dictionary with all available fields
|
101 | 7cfc0cef | Christos Stavrakakis | FIELDS = {} |
102 | 7cfc0cef | Christos Stavrakakis | # List of fields to display by default
|
103 | 7cfc0cef | Christos Stavrakakis | fields = [] |
104 | 7cfc0cef | Christos Stavrakakis | # Default filters and excludes
|
105 | 7cfc0cef | Christos Stavrakakis | filters = {} |
106 | 7cfc0cef | Christos Stavrakakis | excludes = {} |
107 | 7cfc0cef | Christos Stavrakakis | # Order results
|
108 | 7cfc0cef | Christos Stavrakakis | order_by = None
|
109 | 7cfc0cef | Christos Stavrakakis | |
110 | 7cfc0cef | Christos Stavrakakis | # Fields used only with user_user_field
|
111 | 7cfc0cef | Christos Stavrakakis | astakos_url = None
|
112 | 7cfc0cef | Christos Stavrakakis | astakos_token = None
|
113 | 7cfc0cef | Christos Stavrakakis | |
114 | 7cfc0cef | Christos Stavrakakis | help = "Generic List Command"
|
115 | 7cfc0cef | Christos Stavrakakis | option_list = BaseCommand.option_list + ( |
116 | 7cfc0cef | Christos Stavrakakis | make_option( |
117 | 7cfc0cef | Christos Stavrakakis | "-o", "--output", |
118 | 7cfc0cef | Christos Stavrakakis | dest="fields",
|
119 | 7cfc0cef | Christos Stavrakakis | help="Comma-separated list of output fields"),
|
120 | 7cfc0cef | Christos Stavrakakis | make_option( |
121 | 7cfc0cef | Christos Stavrakakis | "--list-fields",
|
122 | 7cfc0cef | Christos Stavrakakis | dest="list_fields",
|
123 | 7cfc0cef | Christos Stavrakakis | action="store_true",
|
124 | 7cfc0cef | Christos Stavrakakis | default=False,
|
125 | 7cfc0cef | Christos Stavrakakis | help="List available output fields"),
|
126 | 7cfc0cef | Christos Stavrakakis | make_option( |
127 | 7cfc0cef | Christos Stavrakakis | "--filter-by",
|
128 | 7cfc0cef | Christos Stavrakakis | dest="filter_by",
|
129 | 7cfc0cef | Christos Stavrakakis | metavar="FILTERS",
|
130 | 7cfc0cef | Christos Stavrakakis | help="Filter results. Comma separated list of key `cond` val pairs"
|
131 | 7cfc0cef | Christos Stavrakakis | " that displayed entries must satisfy. e.g."
|
132 | 7cfc0cef | Christos Stavrakakis | " --filter-by \"deleted=False,id>=22\"."),
|
133 | 7cfc0cef | Christos Stavrakakis | make_option( |
134 | 7cfc0cef | Christos Stavrakakis | "--list-filters",
|
135 | 7cfc0cef | Christos Stavrakakis | dest="list_filters",
|
136 | 7cfc0cef | Christos Stavrakakis | action="store_true",
|
137 | 7cfc0cef | Christos Stavrakakis | default=False,
|
138 | 7cfc0cef | Christos Stavrakakis | help="List available filters"),
|
139 | 7cfc0cef | Christos Stavrakakis | make_option( |
140 | 7cfc0cef | Christos Stavrakakis | "--no-headers",
|
141 | 7cfc0cef | Christos Stavrakakis | dest="headers",
|
142 | 7cfc0cef | Christos Stavrakakis | action="store_false",
|
143 | 7cfc0cef | Christos Stavrakakis | default=True,
|
144 | 7cfc0cef | Christos Stavrakakis | help="Do not display headers"),
|
145 | 7cfc0cef | Christos Stavrakakis | make_option( |
146 | 7cfc0cef | Christos Stavrakakis | "--output-format",
|
147 | 7cfc0cef | Christos Stavrakakis | dest="output_format",
|
148 | 7cfc0cef | Christos Stavrakakis | metavar="[pretty, csv, json]",
|
149 | 7cfc0cef | Christos Stavrakakis | default="pretty",
|
150 | 7cfc0cef | Christos Stavrakakis | choices=["pretty", "csv", "json"], |
151 | 7cfc0cef | Christos Stavrakakis | help="Select the output format: pretty [the default], tabs"
|
152 | 7cfc0cef | Christos Stavrakakis | " [tab-separated output], csv [comma-separated output]"),
|
153 | 7cfc0cef | Christos Stavrakakis | ) |
154 | 7cfc0cef | Christos Stavrakakis | |
155 | 7cfc0cef | Christos Stavrakakis | def __init__(self, *args, **kwargs): |
156 | 7cfc0cef | Christos Stavrakakis | if self.user_uuid_field: |
157 | 7cfc0cef | Christos Stavrakakis | assert(self.astakos_url), "astakos_url attribute is needed when"\ |
158 | 7cfc0cef | Christos Stavrakakis | " user_uuid_field is declared"
|
159 | 7cfc0cef | Christos Stavrakakis | assert(self.astakos_token), "astakos_token attribute is needed"\ |
160 | 7cfc0cef | Christos Stavrakakis | " when user_uuid_field is declared"
|
161 | 7cfc0cef | Christos Stavrakakis | self.option_list += (
|
162 | 7cfc0cef | Christos Stavrakakis | make_option( |
163 | 7cfc0cef | Christos Stavrakakis | "-u", "--user", |
164 | 7cfc0cef | Christos Stavrakakis | dest="user",
|
165 | 7cfc0cef | Christos Stavrakakis | metavar="USER",
|
166 | 7cfc0cef | Christos Stavrakakis | help="List items only for this user."
|
167 | 7cfc0cef | Christos Stavrakakis | " 'USER' can be either a user UUID or a display"
|
168 | 7cfc0cef | Christos Stavrakakis | " name"),
|
169 | 7cfc0cef | Christos Stavrakakis | make_option( |
170 | 7cfc0cef | Christos Stavrakakis | "--display-mails",
|
171 | 7cfc0cef | Christos Stavrakakis | dest="display_mails",
|
172 | 7cfc0cef | Christos Stavrakakis | action="store_true",
|
173 | 7cfc0cef | Christos Stavrakakis | default=False,
|
174 | 7cfc0cef | Christos Stavrakakis | help="Include the user's email"),
|
175 | 7cfc0cef | Christos Stavrakakis | ) |
176 | 7cfc0cef | Christos Stavrakakis | |
177 | 7cfc0cef | Christos Stavrakakis | if self.deleted_field: |
178 | 7cfc0cef | Christos Stavrakakis | self.option_list += (
|
179 | 7cfc0cef | Christos Stavrakakis | make_option( |
180 | 7cfc0cef | Christos Stavrakakis | "-d", "--deleted", |
181 | 7cfc0cef | Christos Stavrakakis | dest="deleted",
|
182 | 7cfc0cef | Christos Stavrakakis | action="store_true",
|
183 | 7cfc0cef | Christos Stavrakakis | help="Display only deleted items"),
|
184 | 7cfc0cef | Christos Stavrakakis | ) |
185 | 7cfc0cef | Christos Stavrakakis | super(ListCommand, self).__init__(*args, **kwargs) |
186 | 7cfc0cef | Christos Stavrakakis | |
187 | 7cfc0cef | Christos Stavrakakis | def handle(self, *args, **options): |
188 | 7cfc0cef | Christos Stavrakakis | if len(args) > 0: |
189 | 7cfc0cef | Christos Stavrakakis | raise CommandError("List commands do not accept any argument") |
190 | 7cfc0cef | Christos Stavrakakis | |
191 | 7cfc0cef | Christos Stavrakakis | assert(self.object_class), "object_class variable must be declared" |
192 | 7cfc0cef | Christos Stavrakakis | |
193 | 7cfc0cef | Christos Stavrakakis | if options["list_fields"]: |
194 | 7cfc0cef | Christos Stavrakakis | self.display_fields()
|
195 | 7cfc0cef | Christos Stavrakakis | return
|
196 | 7cfc0cef | Christos Stavrakakis | |
197 | 7cfc0cef | Christos Stavrakakis | if options["list_filters"]: |
198 | 7cfc0cef | Christos Stavrakakis | self.display_filters()
|
199 | 7cfc0cef | Christos Stavrakakis | return
|
200 | 7cfc0cef | Christos Stavrakakis | |
201 | 7cfc0cef | Christos Stavrakakis | # --output option
|
202 | 7cfc0cef | Christos Stavrakakis | if options["fields"]: |
203 | 7cfc0cef | Christos Stavrakakis | fields = options["fields"]
|
204 | 7cfc0cef | Christos Stavrakakis | fields = fields.split(",")
|
205 | 7cfc0cef | Christos Stavrakakis | self.validate_fields(fields)
|
206 | 7cfc0cef | Christos Stavrakakis | self.fields = options["fields"].split(",") |
207 | 7cfc0cef | Christos Stavrakakis | |
208 | 7cfc0cef | Christos Stavrakakis | # --filter-by option
|
209 | 7cfc0cef | Christos Stavrakakis | if options["filter_by"]: |
210 | 7cfc0cef | Christos Stavrakakis | filters, excludes = utils.parse_filters(options["filter_by"])
|
211 | 7cfc0cef | Christos Stavrakakis | else:
|
212 | 7cfc0cef | Christos Stavrakakis | filters, excludes = ({}, {}) |
213 | 7cfc0cef | Christos Stavrakakis | |
214 | 7cfc0cef | Christos Stavrakakis | self.filters.update(filters)
|
215 | 7cfc0cef | Christos Stavrakakis | self.excludes.update(excludes)
|
216 | 7cfc0cef | Christos Stavrakakis | |
217 | 7cfc0cef | Christos Stavrakakis | # --user option
|
218 | 7cfc0cef | Christos Stavrakakis | user = options.get("user")
|
219 | 7cfc0cef | Christos Stavrakakis | if user:
|
220 | 7cfc0cef | Christos Stavrakakis | if "@" in user: |
221 | 7cfc0cef | Christos Stavrakakis | ucache = UserCache(self.astakos_url, self.astakos_token) |
222 | 7cfc0cef | Christos Stavrakakis | user = ucache.get_uuid(user) |
223 | 7cfc0cef | Christos Stavrakakis | self.filters[self.user_uuid_field] = user |
224 | 7cfc0cef | Christos Stavrakakis | |
225 | 7cfc0cef | Christos Stavrakakis | # --deleted option
|
226 | 7cfc0cef | Christos Stavrakakis | if self.deleted_field: |
227 | 7cfc0cef | Christos Stavrakakis | deleted = options.get("deleted")
|
228 | 7cfc0cef | Christos Stavrakakis | if deleted:
|
229 | 7cfc0cef | Christos Stavrakakis | self.filters[self.deleted_field] = True |
230 | 7cfc0cef | Christos Stavrakakis | else:
|
231 | 7cfc0cef | Christos Stavrakakis | self.filters[self.deleted_field] = False |
232 | 7cfc0cef | Christos Stavrakakis | |
233 | 7cfc0cef | Christos Stavrakakis | # Special handling of arguments
|
234 | 7cfc0cef | Christos Stavrakakis | self.handle_args(self, *args, **options) |
235 | 7cfc0cef | Christos Stavrakakis | |
236 | 3b6afb38 | Christos Stavrakakis | select_related = getattr(self, "select_related", []) |
237 | 3b6afb38 | Christos Stavrakakis | prefetch_related = getattr(self, "prefetch_related", []) |
238 | 3b6afb38 | Christos Stavrakakis | |
239 | 7cfc0cef | Christos Stavrakakis | objects = self.object_class.objects
|
240 | 7cfc0cef | Christos Stavrakakis | try:
|
241 | 3b6afb38 | Christos Stavrakakis | for sr in select_related: |
242 | 3b6afb38 | Christos Stavrakakis | objects = objects.select_related(sr) |
243 | 3b6afb38 | Christos Stavrakakis | for pr in prefetch_related: |
244 | 3b6afb38 | Christos Stavrakakis | objects = objects.prefetch_related(pr) |
245 | 7cfc0cef | Christos Stavrakakis | objects = objects.filter(**self.filters)
|
246 | 7cfc0cef | Christos Stavrakakis | objects = objects.exclude(**self.excludes)
|
247 | 7cfc0cef | Christos Stavrakakis | except FieldError as e: |
248 | 7cfc0cef | Christos Stavrakakis | raise CommandError(e)
|
249 | 7cfc0cef | Christos Stavrakakis | except Exception as e: |
250 | 7cfc0cef | Christos Stavrakakis | raise CommandError("Can not filter results: %s" % e) |
251 | 7cfc0cef | Christos Stavrakakis | |
252 | 7cfc0cef | Christos Stavrakakis | order_key = self.order_by if self.order_by is not None else 'pk' |
253 | 7cfc0cef | Christos Stavrakakis | objects = objects.order_by(order_key) |
254 | 7cfc0cef | Christos Stavrakakis | |
255 | 7cfc0cef | Christos Stavrakakis | # --display-mails option
|
256 | 7cfc0cef | Christos Stavrakakis | display_mails = options.get("display_mails")
|
257 | 7cfc0cef | Christos Stavrakakis | if display_mails:
|
258 | 7cfc0cef | Christos Stavrakakis | if 'user_mail' in self.object_class._meta.get_all_field_names(): |
259 | 7cfc0cef | Christos Stavrakakis | raise RuntimeError("%s has already a 'user_mail' attribute") |
260 | 7cfc0cef | Christos Stavrakakis | |
261 | 7cfc0cef | Christos Stavrakakis | self.fields.append("user.email") |
262 | 7cfc0cef | Christos Stavrakakis | self.FIELDS["user.email"] =\ |
263 | 7cfc0cef | Christos Stavrakakis | ("user_email", "The email of the owner.") |
264 | 7cfc0cef | Christos Stavrakakis | uuids = [getattr(obj, self.user_uuid_field) for obj in objects] |
265 | 7cfc0cef | Christos Stavrakakis | ucache = UserCache(self.astakos_url, self.astakos_token) |
266 | 7cfc0cef | Christos Stavrakakis | ucache.fetch_names(list(set(uuids))) |
267 | 7cfc0cef | Christos Stavrakakis | for obj in objects: |
268 | 7cfc0cef | Christos Stavrakakis | uuid = getattr(obj, self.user_uuid_field) |
269 | 7cfc0cef | Christos Stavrakakis | obj.user_email = ucache.get_name(uuid) |
270 | 7cfc0cef | Christos Stavrakakis | |
271 | 7cfc0cef | Christos Stavrakakis | # Special handling of DB results
|
272 | 7cfc0cef | Christos Stavrakakis | objects = list(objects)
|
273 | 7cfc0cef | Christos Stavrakakis | self.handle_db_objects(objects, **options)
|
274 | 7cfc0cef | Christos Stavrakakis | |
275 | 7cfc0cef | Christos Stavrakakis | headers = self.fields
|
276 | 7cfc0cef | Christos Stavrakakis | columns = [self.FIELDS[key][0] for key in headers] |
277 | 7cfc0cef | Christos Stavrakakis | |
278 | 7cfc0cef | Christos Stavrakakis | table = [] |
279 | 7cfc0cef | Christos Stavrakakis | for obj in objects: |
280 | 7cfc0cef | Christos Stavrakakis | row = [] |
281 | 7cfc0cef | Christos Stavrakakis | for attr in columns: |
282 | 7cfc0cef | Christos Stavrakakis | if callable(attr): |
283 | 7cfc0cef | Christos Stavrakakis | row.append(attr(obj)) |
284 | 7cfc0cef | Christos Stavrakakis | else:
|
285 | 7cfc0cef | Christos Stavrakakis | item = obj |
286 | 7cfc0cef | Christos Stavrakakis | attrs = attr.split(".")
|
287 | 7cfc0cef | Christos Stavrakakis | for attr in attrs: |
288 | 7cfc0cef | Christos Stavrakakis | item = getattr(item, attr)
|
289 | 7cfc0cef | Christos Stavrakakis | row.append(item) |
290 | 7cfc0cef | Christos Stavrakakis | table.append(row) |
291 | 7cfc0cef | Christos Stavrakakis | |
292 | 7cfc0cef | Christos Stavrakakis | # Special handle of output
|
293 | 7cfc0cef | Christos Stavrakakis | self.handle_output(table, headers)
|
294 | 7cfc0cef | Christos Stavrakakis | |
295 | 7cfc0cef | Christos Stavrakakis | # Print output
|
296 | 7cfc0cef | Christos Stavrakakis | output_format = options["output_format"]
|
297 | 7cfc0cef | Christos Stavrakakis | if output_format != "json" and not options["headers"]: |
298 | 7cfc0cef | Christos Stavrakakis | headers = None
|
299 | 7cfc0cef | Christos Stavrakakis | utils.pprint_table(self.stdout, table, headers, output_format)
|
300 | 7cfc0cef | Christos Stavrakakis | |
301 | 7cfc0cef | Christos Stavrakakis | def handle_args(self, *args, **kwargs): |
302 | 7cfc0cef | Christos Stavrakakis | pass
|
303 | 7cfc0cef | Christos Stavrakakis | |
304 | 7cfc0cef | Christos Stavrakakis | def handle_db_objects(self, objects, **options): |
305 | 7cfc0cef | Christos Stavrakakis | pass
|
306 | 7cfc0cef | Christos Stavrakakis | |
307 | 7cfc0cef | Christos Stavrakakis | def handle_output(self, table, headers): |
308 | 7cfc0cef | Christos Stavrakakis | pass
|
309 | 7cfc0cef | Christos Stavrakakis | |
310 | 7cfc0cef | Christos Stavrakakis | def display_fields(self): |
311 | 7cfc0cef | Christos Stavrakakis | headers = ["Field", "Description"] |
312 | 7cfc0cef | Christos Stavrakakis | table = [] |
313 | 7cfc0cef | Christos Stavrakakis | for field, (_, help_msg) in self.FIELDS.items(): |
314 | 7cfc0cef | Christos Stavrakakis | table.append((field, help_msg)) |
315 | 7cfc0cef | Christos Stavrakakis | utils.pprint_table(self.stdout, table, headers)
|
316 | 7cfc0cef | Christos Stavrakakis | |
317 | 7cfc0cef | Christos Stavrakakis | def validate_fields(self, fields): |
318 | 7cfc0cef | Christos Stavrakakis | for f in fields: |
319 | 7cfc0cef | Christos Stavrakakis | if f not in self.FIELDS.keys(): |
320 | 7cfc0cef | Christos Stavrakakis | raise CommandError("Unknown field '%s'. 'Use --list-fields" |
321 | 7cfc0cef | Christos Stavrakakis | " option to find out available fields."
|
322 | 7cfc0cef | Christos Stavrakakis | % f) |
323 | 7cfc0cef | Christos Stavrakakis | |
324 | 7cfc0cef | Christos Stavrakakis | def display_filters(self): |
325 | 7cfc0cef | Christos Stavrakakis | headers = ["Filter", "Description", "Help"] |
326 | 7cfc0cef | Christos Stavrakakis | table = [] |
327 | 7cfc0cef | Christos Stavrakakis | for field in self.object_class._meta.fields: |
328 | 7cfc0cef | Christos Stavrakakis | table.append((field.name, field.verbose_name, field.help_text)) |
329 | 7cfc0cef | Christos Stavrakakis | utils.pprint_table(self.stdout, table, headers) |