^Q\b@sddlmZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZd d lmZd d lmZd d lmZd dlmZd dlmZmZmZmZmZGddde Z!Gddde"Z#Gddde"Z$ej%e!Gddde$Z&e&dddddZ'dS))unicode_literalsN) OrderedDict)count)settings) Paginator) get_template)six) force_text)columns) RequestConfig) TableData) BoundRows)Accessor AttributeDictOrderBy OrderByTupleSequencecs(eZdZdZfddZS)DeclarativeColumnsMetaclassz Metaclass that converts `.Column` objects defined on a class to the dictionary `.Table.base_columns`, taking into account parent class `base_columns` as well. cst|jdd|d<}gi}}xU|jD]G\}}t|tjrwd|_|j||fq:|||)sz5DeclarativeColumnsMetaclass.__new__.. base_columnsF) TableOptionsgetitems isinstancer ZColumnZ _explicitappendsortreversedhasattrlistrrmodelfieldsr get_fieldZlibraryZcolumn_for_fieldrnameupdateexcludepopkeyslocalize unlocalizesuperr__new__)Zmcsr)basesattrsoptscols remainder attr_nameattrZparent_columnsbaserextra field_namefieldrcolZ exclusionZcol_nameZlocalize_column) __class__rrr1sV              z#DeclarativeColumnsMetaclass.__new__)__name__ __module__ __qualname____doc__r1rr)r>rrs rcs+eZdZdZdfddZS)ra Extracts and exposes options for a `.Table` from a `.Table.Meta` when the table is defined. See `.Table` for documentation on the impact of variables in this class. Arguments: options (`.Table.Meta`): options for a table from `.Table.Meta` Ncs^tt|jttdd}ttdi}tt|d||_t|di|_t|di|_t|dd|_ t|d d|_ t|d d|_ t|d f|_ t|d d}t |tjr|f}n|dk rt|nd|_t|d d|_t|dd|_t|dd|_t|dd|_t|dd|_t|dd|_tt|df|_t|dd|_t|dd|_t|drt|d||_tjdt nt|d||_t|df|_!t|df|_"dS) NDJANGO_TABLES2_TEMPLATEzdjango_tables2/table.htmlDJANGO_TABLES2_TABLE_ATTRSr3 row_attrspinned_row_attrsdefaultu— empty_textr'r+order_byorder_by_fieldr" page_fieldpageper_pageper_page_fieldprefix show_headerTsequence orderabler&templatez=Table.Meta.template is deprecated. Use template_name instead. template_namer.r/)#r0r__init__getattrrrr3rErFrGrHr'r+r r string_typesrrIrJrKrMrOrPrRrrSrTr&r$rVwarningswarnDeprecationWarningr.r/)selfoptionsrCrDrI)r>rrrWqs: !zTableOptions.__init__)r?r@rArBrWrr)r>rrhs rcseeZdZdZddddddddddddddddddddfddZddZdd Zd d Zd d ZdddZ ddZ e ddZ e j ddZ e ddZej ddZe ddZej ddZe ddZej ddZedddd Ze d!d"Zej d#d"Ze d$d%Zej d&d%Ze d'd(Ze d)d*Ze d+d,Ze d-d.Zej d/d.Ze d0d1Zej d2d1Ze d3d4Zej d5d4Zd6d7ZS)8 TableBasea A representation of a table. Arguments: data (queryset, list of dicts): The data to display. This is a required variable, a `TypeError` will be raised if it's not passed. order_by: (tuple or str): The default ordering tuple or comma separated str. A hyphen `-` can be used to prefix a column name to indicate *descending* order, for example: `('name', '-age')` or `name,-age`. orderable (bool): Enable/disable column ordering on this table empty_text (str): Empty text to render when the table has no data. (default `.Table.Meta.empty_text`) exclude (iterable or str): The names of columns that shouldn't be included in the table. attrs (dict): HTML attributes to add to the ```` tag. When accessing the attribute, the value is always returned as an `.AttributeDict` to allow easily conversion to HTML. row_attrs: Add custom html attributes to the table rows. Allows custom HTML attributes to be specified which will be added to the ```` tag of the rendered table. pinned_row_attrs: Same as row_attrs but for pinned rows. sequence (iterable): The sequence/order of columns the columns (from left to right). Items in the sequence must be :term:`column names `, or `'...'` (string containing three periods). `'...'` can be used as a catch-all for columns that aren't specified. prefix (str): A prefix for querystring fields. To avoid name-clashes when using multiple tables on single page. order_by_field (str): If not `None`, defines the name of the *order by* querystring field in the url. page_field (str): If not `None`, defines the name of the *current page* querystring field. per_page_field (str): If not `None`, defines the name of the *per page* querystring field. template_name (str): The template to render when using ``{% render_table %}`` (defaults to DJANGO_TABLES2_TEMPLATE, which is ``'django_tables2/table.html'`` by default). default (str): Text to render in empty cells (determined by `.Column.empty_values`, default `.Table.Meta.default`) request: Django's request to avoid using `RequestConfig` show_header (bool): If `False`, the table will not have a header (``), defaults to `True` show_footer (bool): If `False`, the table footer will not be rendered, even if some columns have a footer, defaults to `True`. extra_columns (str, `.Column`): list of `(name, column)`-tuples containing extra columns to add to the instance. NTcswtt|j|dkr@tdjt|jn|pO|jj|_| |_ t j d|d||_ |dkr|jj }n||_ t|p|jj|_i|jd6|jd6|_td|j d|d|j|_t|dk r|n |jj|_t|p8|jj|_|dk rS|n |jj|_||_| |_| |_| |_| |_||_||_tj t|j!|dk rx!|D]\}}||sz%TableBase.__init__..zDtemplate argument to Table is deprecated. Use template_name instead.)rd)rd)6r0r_rW TypeErrorformattyper?rr+rSr Z from_datar`rGrrFget_top_pinned_dataget_bottom_pinned_datarcrrowsr3rErHrTrPrJrKrOrR show_footercopydeepcopyrrr'tupleexpandr- _sequencerr Z BoundColumnsrI _order_byZorderingrVrZr[r\r Z configurer_counter)r]r`rIrTrHr+r3rErFrSrPrJrKrOrUrVrGrequestrRrmZ extra_columnsr)column)r>)rrrWsl !    $'!                   zTableBase.__init__cCsdS)a% Return data for top pinned rows containing data for each row. Iterable type like: queryset, list of dicts, list of objects. Having a non-zero number of pinned rows will not result in an empty resultset message being rendered, even if there are no regular data rows Returns: `None` (default) no pinned rows at the top, iterable, data for pinned rows at the top. Note: To show pinned row this method should be overridden. Example: >>> class TableWithTopPinnedRows(Table): ... def get_top_pinned_data(self): ... return [{ ... 'column_a' : 'some value', ... 'column_c' : 'other value', ... }] Nr)r]rrrrj6szTableBase.get_top_pinned_datacCsdS)a4 Return data for bottom pinned rows containing data for each row. Iterable type like: queryset, list of dicts, list of objects. Having a non-zero number of pinned rows will not result in an empty resultset message being rendered, even if there are no regular data rows Returns: `None` (default) no pinned rows at the bottom, iterable, data for pinned rows at the bottom. Note: To show pinned row this method should be overridden. Example: >>> class TableWithBottomPinnedRows(Table): ... def get_bottom_pinned_data(self): ... return [{ ... 'column_a' : 'some value', ... 'column_c' : 'other value', ... }] Nr)r]rrrrkNsz TableBase.get_bottom_pinned_datacCsdS)a  A way to hook into the moment just before rendering the template. Can be used to hide a column. Arguments: request: contains the `WGSIRequest` instance, containing a `user` attribute if `.django.contrib.auth.middleware.AuthenticationMiddleware` is added to your `MIDDLEWARE_CLASSES`. Example:: class Table(tables.Table): name = tables.Column(orderable=False) country = tables.Column(orderable=False) def before_render(self, request): if request.user.has_perm('foo.delete_bar'): self.columns.hide('country') else: self.columns.show('country') Nr)r]rurrr before_renderfszTableBase.before_rendercCsIt|_t|j}i|d6|d6}|j||j|S)zU Render the table to an HTML table, adding `request` to the context. raru)rrtrrVrwZrender)r]rurUcontextrrras_htmls   zTableBase.as_htmlc#s{dkrfnfddfdd|jDVx2|jD]'fddjjDVqLWdS)a Return a row iterator of the data which would be shown in the table where the first row is the table headers. arguments: exclude_columns (iterable): columns to exclude in the data iterator. This can be used to output the table data as CSV, excel, for example using the `~.export.ExportMixin`. If a column is defined using a :ref:`table.render_FOO`, the returned value from that method is used. If you want to differentiate between the rendered cell and a value, use a `value_Foo`-method:: class Table(tables.Table): name = tables.Column() def render_name(self, value): return format_html('{}', value) def value_name(self, value): return value will have a value wrapped in `` in the rendered HTML, and just returns the value when `as_values()` is called. Ncs|jjrdS|jkS)NT)rvZexclude_from_exportr))rv)exclude_columnsrrexcludeds z%TableBase.as_values..excludedcs1g|]'}|st|jddqS) strings_onlyT)r header)rerv)r{rr s z'TableBase.as_values..cs:g|]0}|stj|jddqS)r|T)r Zget_cell_valuer))rerv)r{rowrrr~s )r rlra)r]rzr)rzr{rr as_valuess   zTableBase.as_valuescCs#|jo"tdd|jDS)z{ Returns True if any of the columns define a ``_footer`` attribute or a ``render_footer()`` method css|]}|jVqdS)N) has_footer)rervrrrrfsz'TableBase.has_footer..)rmanyr )r]rrrrszTableBase.has_footercCs |jdk r|jS|jjS)N) _show_headerrrR)r]rrrrRszTableBase.show_headercCs ||_dS)N)r)r]valuerrrrRscCs|jS)N)rs)r]rrrrIszTableBase.order_bycCs|s fn|}t|tjr3|jdn|}g}xL|D]D}t|j}||jkrF|j|jrF|j|qFqFWt ||_ |j j |j dS)z Order the rows of the table based on columns. Arguments: value: iterable or comma separated string of order by aliases. ,N) r rrYsplitrZbarer rTr!rrsr`rI)r]rrIZvalidaliasr)rrrrIs ' cCs |jdk r|jS|jjS)N)_order_by_fieldrrJ)r]rrrrJszTableBase.order_by_fieldcCs ||_dS)N)r)r]rrrrrJscCs |jdk r|jS|jjS)N) _page_fieldrrK)r]rrrrKszTableBase.page_fieldcCs ||_dS)N)r)r]rrrrrKsr cOsF|p|jj}||j||||_|jj||_dS)a Paginates the table using a paginator and creates a ``page`` property containing information for the current page. Arguments: klass (`~django.core.paginator.Paginator`): A paginator class to paginate the results. per_page (int): Number of records to display on each page. page (int): Page to display. Extra arguments are passed to the paginator. Pagination exceptions (`~django.core.paginator.EmptyPage` and `~django.core.paginator.PageNotAnInteger`) may be raised from this method and should be handled by the caller. N)rrMrlZ paginatorrL)r]klassrMrLargskwargsrrrpaginateszTableBase.paginatecCs |jdk r|jS|jjS)N)_per_page_fieldrrO)r]rrrrOszTableBase.per_page_fieldcCs ||_dS)N)r)r]rrrrrOscCs |jdk r|jS|jjS)N)_prefixrrP)r]rrrrPszTableBase.prefixcCs ||_dS)N)r)r]rrrrrPscCsd|j|jfS)Nz%s%s)rPrJ)r]rrrprefixed_order_by_field!sz!TableBase.prefixed_order_by_fieldcCsd|j|jfS)Nz%s%s)rPrK)r]rrrprefixed_page_field%szTableBase.prefixed_page_fieldcCsd|j|jfS)Nz%s%s)rPrO)r]rrrprefixed_per_page_field)sz!TableBase.prefixed_per_page_fieldcCs|jS)N)rr)r]rrrrS-szTableBase.sequencecCs8|r+t|}|j|jjn||_dS)N)rrqrr-rr)r]rrrrrS1s cCs$|jdk r|jS|jjSdS)N) _orderablerrT)r]rrrrT8szTableBase.orderablecCs ||_dS)N)r)r]rrrrrT?scCs$|jdk r|jS|jjSdS)N) _templaterrV)r]rrrrVCszTableBase.template_namecCs ||_dS)N)r)r]rrrrrVJscCs|j|j|S)a Returns a set of HTML class names for cells (both td and th) of a **bound column** in this table. By default this returns the column class names defined in the table's attributes, and additionally the bound column's name. This method can be overridden to change the default behavior, for example to simply `return classes_set`. Arguments: classes_set(set of string): a set of class names to be added to the cell, retrieved from the column's attributes. In the case of a header cell (th), this also includes ordering classes. To set the classes for a column, see `.Column`. To configure ordering classes, see :ref:`ordering-class-name` bound_column(`.BoundColumn`): the bound column the class names are determined for. Useful for accessing `bound_column.name`. Returns: A set of class names to be added to cells of this column )addr))r]Z classes_setZ bound_columnrrrget_column_class_namesNsz TableBase.get_column_class_names)r?r@rArBrWrjrkrwryrrpropertyrRsetterrIrJrKrrrOrPrrrrSrTrVrrr)r>rr_sF B   [    - r_c@seZdZejZdS)TableN)r?r@rAr_rBrrrrris rc Csi|d6}|dk r&||ds,  (R,