Ensure all table columns are capable of rendering plain text #4627

New Issue

adam · 2025-12-29T18:38:27+01:00

adam commented

2025-12-29 18:38:27 +01:00

Originally created by @jeremystretch on GitHub (Mar 4, 2021).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

All custom table columns should define a value() method which returns a plain text string suitable for CSV-formatted output. This output should not contain any HTML.

Similarly, we'll need to look into options for supporting plaintext rendering on template columns. By default, calling value() on a TemplateColumn calls strip_tags() on the output of its render() method, though I'm wondering if we might come up with something more elegant.

Justification

This work is necessary to support #4999, which seeks to generate CSV exports using the table class.

Originally created by @jeremystretch on GitHub (Mar 4, 2021). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes All custom table columns should define a `value()` method which returns a plain text string suitable for CSV-formatted output. This output should not contain any HTML. Similarly, we'll need to look into options for supporting plaintext rendering on template columns. By default, calling `value()` on a TemplateColumn calls `strip_tags()` on the output of its `render()` method, though I'm wondering if we might come up with something more elegant. ### Justification This work is necessary to support #4999, which seeks to generate CSV exports using the table class.

adam added the status: accepted type: housekeeping labels 2025-12-29 18:38:27 +01:00

adam closed this issue

2025-12-29 18:38:28 +01:00

adam commented

2025-12-29 18:38:28 +01:00

@jeremystretch commented on GitHub (Mar 5, 2021):

Submitted a PR to django-tables2 to call strip() to remove leading and trailing whitespace when rendering the plaintext value ofa TemplateColumn. If accepted, this will obviate much of the necessary template cleanup.

@jeremystretch commented on GitHub (Mar 5, 2021): Submitted a [PR to django-tables2](https://github.com/jieter/django-tables2/pull/794) to call `strip()` to remove leading and trailing whitespace when rendering the plaintext value ofa TemplateColumn. If accepted, this will obviate much of the necessary template cleanup.

adam commented

2025-12-29 18:38:29 +01:00

@jeremystretch commented on GitHub (Mar 8, 2021):

Marking as blocked for now; waiting to see if the aforementioned PR will be accepted upstream.

@jeremystretch commented on GitHub (Mar 8, 2021): Marking as blocked for now; waiting to see if the aforementioned PR will be accepted upstream.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#4627