Skip to content
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

UI refactorings #262

Merged
merged 4 commits into from
Jan 4, 2022
Merged

UI refactorings #262

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
ea6b789
Improve add_column() signature
dlax Jan 3, 2022
237bb27
Inline text_append()
dlax Jan 3, 2022
a64041b
Rewrite columns_header() tests without doctest
dlax Jan 3, 2022
44026d8
Rework types.Column model
dlax Jan 3, 2022
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
127 changes: 83 additions & 44 deletions pgactivity/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import attr
import psutil
from attr import validators

from . import colors, utils

Expand Down Expand Up @@ -203,7 +204,8 @@ class DurationMode(enum.IntEnum):
class Column:
"""A column in stats table.

>>> c = Column("pid", "PID", "%-6s", True, SortKey.cpu, max_width=6,
>>> c = Column("pid", "PID", mandatory=True, sort_key=SortKey.cpu,
... min_width=6, max_width=6,
... transform=lambda v: str(v)[::-1])
>>> c.title_render()
'PID '
Expand All @@ -217,53 +219,63 @@ class Column:
'876543'
>>> c.color_key
'pid'

>>> c = attr.evolve(c, justify="right", min_width=4, max_width=5)
>>> c.title_render()
' PID'
>>> c.render('7654321')
'12345'
>>> c.render('21')
' 12'
"""

key: str = attr.ib(repr=False)
name: str
template_h: str = attr.ib()
mandatory: bool = False
sort_key: Optional[SortKey] = None
min_width: int = attr.ib(default=0, repr=False)
max_width: Optional[int] = attr.ib(default=None, repr=False)
justify: str = attr.ib(
"left", validator=validators.in_(["left", "center", "right"])
)
transform: Callable[[Any], str] = attr.ib(default=str, repr=False)
color_key: Union[str, Callable[[Any], str]] = attr.ib(
default=_color_key_marker, repr=False
)

@template_h.validator
def _template_h_is_a_format_string_(self, attribute: Any, value: str) -> None:
"""Validate template_h attribute.

>>> Column("k", "a", "b%%aa")
Traceback (most recent call last):
...
ValueError: template_h must be a format string with one placeholder
>>> Column("k", "a", "baad")
Traceback (most recent call last):
...
ValueError: template_h must be a format string with one placeholder
>>> Column("k", "a", "%s is good") # doctest: +ELLIPSIS
Column(name='a', template_h='%s is good', ...)
"""
if value.count("%") != 1:
raise ValueError(
f"{attribute.name} must be a format string with one placeholder"
)
_justify: Callable[[str], str] = attr.ib(init=False)

def __attrs_post_init__(self) -> None:
if self.color_key == _color_key_marker:
object.__setattr__(self, "color_key", self.key)

if self.justify == "left":

def _justify(value: str) -> str:
return value.ljust(self.min_width)[: self.max_width]

elif self.justify == "right":

def _justify(value: str) -> str:
return value.rjust(self.min_width)[: self.max_width]

elif self.justify == "center":

def _justify(value: str) -> str:
return value.center(self.min_width)[: self.max_width]

object.__setattr__(self, "_justify", _justify)

def title_render(self) -> str:
return self.template_h % self.name
return self._justify(self.name)

def title_color(self, sort_by: SortKey) -> str:
if self.sort_key == sort_by:
return "cyan" # TODO: define a Color enum
return "green"

def render(self, value: Any) -> str:
return self.template_h % self.transform(value)[: self.max_width]
return self._justify(self.transform(value))

def color(self, value: Any) -> str:
if callable(self.color_key):
Expand Down Expand Up @@ -300,36 +312,38 @@ def make(
) -> "UI":
possible_columns: Dict[str, Column] = {}

def add_column(key: str, **kwargs: Any) -> None:
def add_column(key: str, name: str, **kwargs: Any) -> None:
assert key not in possible_columns, f"duplicated key {key}"
possible_columns[key] = Column(key, **kwargs)
possible_columns[key] = Column(key=key, name=name, **kwargs)

if Flag.APPNAME & flag:
add_column(
key="application_name",
name="APP",
template_h="%16s ",
min_width=16,
max_width=16,
justify="right",
)
if Flag.CLIENT & flag:
add_column(
key="client",
name="CLIENT",
template_h="%16s ",
min_width=16,
max_width=16,
justify="right",
)
if Flag.CPU & flag:
add_column(
key="cpu",
name="CPU%",
template_h="%6s ",
min_width=6,
sort_key=SortKey.cpu,
)
if Flag.DATABASE & flag:
add_column(
key="database",
name="DATABASE(*)" if filters.dbname else "DATABASE",
template_h=f"%-{max_db_length}s ",
min_width=max_db_length,
transform=functools.lru_cache()(
lambda v: utils.ellipsis(v, width=16) if v else "",
),
Expand All @@ -339,78 +353,103 @@ def add_column(key: str, **kwargs: Any) -> None:
add_column(
key="io_wait",
name="IOW",
template_h="%4s ",
min_width=4,
transform=utils.yn,
color_key=colors.wait,
)
if Flag.MEM & flag:
add_column(
key="mem",
name="MEM%",
template_h="%4s ",
min_width=4,
sort_key=SortKey.mem,
transform=lambda v: str(round(v, 1)),
)
if Flag.MODE & flag:
add_column(
key="mode",
name="MODE",
template_h="%16s ",
min_width=16,
max_width=16,
justify="right",
color_key=colors.lock_mode,
)
if Flag.PID & flag:
add_column(key="pid", name="PID", template_h="%-6s ")
add_column(key="query", name="Query", template_h=" %2s")
add_column(
key="pid",
name="PID",
min_width=6,
)
add_column(
key="query",
name="Query",
min_width=2,
)
if Flag.READ & flag:
add_column(
key="read",
name="READ/s",
template_h="%8s ",
min_width=8,
sort_key=SortKey.read,
transform=utils.naturalsize,
)
if Flag.RELATION & flag:
add_column(
key="relation",
name="RELATION",
template_h="%9s ",
min_width=9,
max_width=9,
justify="right",
)
add_column(
key="state",
name="state",
template_h=" %17s ",
min_width=17,
justify="right",
transform=utils.short_state,
color_key=colors.short_state,
)
if Flag.TIME & flag:
add_column(
key="duration",
name="TIME+",
template_h="%9s ",
min_width=9,
justify="right",
sort_key=SortKey.duration,
transform=lambda v: utils.format_duration(v)[0],
color_key=lambda v: utils.format_duration(v)[1],
)
if Flag.TYPE & flag:
add_column(key="type", name="TYPE", template_h="%16s ", max_width=16)
add_column(
key="type",
name="TYPE",
min_width=16,
max_width=16,
justify="right",
)
if Flag.USER & flag:
add_column(key="user", name="USER", template_h="%16s ", max_width=16)
add_column(
key="user",
name="USER",
min_width=16,
max_width=16,
justify="right",
)
if Flag.WAIT & flag:
add_column(
key="wait",
name="Waiting",
template_h="%16s ",
min_width=16,
max_width=16,
justify="right",
transform=utils.wait_status,
color_key=colors.wait,
max_width=16,
)
if Flag.WRITE & flag:
add_column(
key="write",
name="WRITE/s",
template_h="%8s ",
min_width=8,
sort_key=SortKey.write,
transform=utils.naturalsize,
)
Expand Down Expand Up @@ -574,7 +613,7 @@ def column(self, key: str) -> Column:

>>> ui = UI.make()
>>> ui.column("cpu") # doctest: +ELLIPSIS
Column(name='CPU%', template_h='%6s ', mandatory=False, sort_key=...)
Column(name='CPU%', mandatory=False, sort_key=...)
>>> ui.column("gloups")
Traceback (most recent call last):
...
Expand Down
23 changes: 8 additions & 15 deletions pgactivity/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ def columns_header(term: Terminal, ui: UI) -> Iterator[str]:
for column in ui.columns():
color = getattr(term, f"black_on_{column.title_color(ui.sort_key)}")
htitles.append(f"{color}{column.title_render()}")
yield term.ljust("".join(htitles), fillchar=" ") + term.normal
yield term.ljust(" ".join(htitles), fillchar=" ") + term.normal


def get_indent(ui: UI) -> str:
Expand All @@ -288,16 +288,12 @@ def get_indent(ui: UI) -> str:
>>> from pgactivity.types import Flag, UI
>>> ui = UI.make(flag=Flag.CPU)
>>> get_indent(ui)
' '
' '
>>> ui = UI.make(flag=Flag.PID | Flag.DATABASE | Flag.APPNAME | Flag.RELATION)
>>> get_indent(ui)
' '
' '
"""
indent = ""
for column in ui.columns():
if column.name != "Query":
indent += column.template_h % " "
return indent
return " " * sum(c.min_width + 1 for c in ui.columns() if c.name != "Query")


def format_query(query: str, is_parallel_worker: bool) -> str:
Expand Down Expand Up @@ -325,17 +321,14 @@ def processes_rows(
if width is None:
width = term.width

def text_append(value: str) -> None:
# We also restore 'normal' style so that the next item does not
# inherit previous one's style.
text.append(value + term.normal)

def cell(
value: Any,
column: Column,
) -> None:
color = getattr(term, colors.FIELD_BY_MODE[column.color(value)][color_type])
text_append(f"{color}{column.render(value)}")
# We also restore 'normal' style so that the next item does not
# inherit from that of the previous one.
text.append(f"{color}{column.render(value)}{term.normal}")

focused, pinned = processes.focused, processes.pinned

Expand Down Expand Up @@ -402,7 +395,7 @@ def cell(

cell(query_value, ui.column("query"))

for line in ("".join(text) + term.normal).splitlines():
for line in (" ".join(text) + term.normal).splitlines():
yield line


Expand Down
Loading