Skip to content

Adds a column with the argument secret=True to Table._meta.secret_columns #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dantownsend merged 4 commits into from
Aug 3, 2025
Merged

Adds a column with the argument secret=True to Table._meta.secret_columns #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7ff747
adds a column with the argument secret=True to the table meta secret …
sinisaos Jul 30, 2025
c3a2f61
adds @dantownsend sugestions
sinisaos Jul 31, 2025
f47b2b3
tweak tests
dantownsend Aug 3, 2025
bf1fc44
Merge branch 'master' into pr/1235
dantownsend Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions piccolo/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
Email,
ForeignKey,
ReferencedTable,
Secret,
Serial,
)
from piccolo.columns.defaults.base import Default
Expand Down Expand Up @@ -84,7 +83,7 @@ class TableMeta:
foreign_key_columns: list[ForeignKey] = field(default_factory=list)
primary_key: Column = field(default_factory=Column)
json_columns: list[Union[JSON, JSONB]] = field(default_factory=list)
secret_columns: list[Secret] = field(default_factory=list)
secret_columns: list[Column] = field(default_factory=list)
auto_update_columns: list[Column] = field(default_factory=list)
tags: list[str] = field(default_factory=list)
help_text: Optional[str] = None
Expand Down Expand Up @@ -274,7 +273,7 @@ def __init_subclass__(
non_default_columns: list[Column] = []
array_columns: list[Array] = []
foreign_key_columns: list[ForeignKey] = []
secret_columns: list[Secret] = []
secret_columns: list[Column] = []
json_columns: list[Union[JSON, JSONB]] = []
email_columns: list[Email] = []
auto_update_columns: list[Column] = []
Expand Down Expand Up @@ -315,15 +314,15 @@ def __init_subclass__(
if isinstance(column, Email):
email_columns.append(column)

if isinstance(column, Secret):
secret_columns.append(column)

if isinstance(column, ForeignKey):
foreign_key_columns.append(column)

if isinstance(column, (JSON, JSONB)):
json_columns.append(column)

if column._meta.secret:
secret_columns.append(column)

if column._meta.auto_update is not ...:
auto_update_columns.append(column)

Expand Down
10 changes: 7 additions & 3 deletions tests/table/test_metaclass.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
from unittest import TestCase
from unittest.mock import MagicMock, patch

from piccolo.columns import Secret
from piccolo.columns.column_types import (
JSON,
JSONB,
Array,
Email,
ForeignKey,
Secret,
Varchar,
)
from piccolo.table import TABLENAME_WARNING, Table
Expand Down Expand Up @@ -99,14 +99,18 @@ class TableB(Table):

def test_secret_columns(self):
"""
Make sure TableMeta.secret_columns are setup correctly.
Make sure TableMeta.secret_columns are setup correctly with the
``secret=True`` argument and ``Secret`` column type.
"""

class Classified(Table):
top_secret = Secret()
confidential = Varchar(secret=True)
public = Varchar()

self.assertEqual(
Classified._meta.secret_columns, [Classified.top_secret]
Classified._meta.secret_columns,
[Classified.top_secret, Classified.confidential],
)

def test_json_columns(self):
Expand Down