Skip to content

Changing logic to include tab replacement and glyph calculation #121

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

Closed
wants to merge 7 commits into from
Closed

Changing logic to include tab replacement and glyph calculation #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d99d16f
Changing logic to include tab replacement and glyph calculation
jposada202020 Feb 20, 2021
c7b6fd2
adding text treatment to address corner case when max_glyphs values i…
jposada202020 Feb 20, 2021
8c2a73b
Including review regarding text logic in if statement
jposada202020 Feb 23, 2021
90f2973
Black and Pylint
jposada202020 Feb 23, 2021
2e860cc
Addding tab verification when setter is called
jposada202020 Feb 25, 2021
cbc5963
Tab verification for Bitmap Label
jposada202020 Feb 25, 2021
71270ce
New parameter to include the possibility to define the number a type …
jposada202020 Feb 27, 2021
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
20 changes: 14 additions & 6 deletions adafruit_display_text/bitmap_label.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class Label(displayio.Group):
:param bool save_text: Set True to save the text string as a constant in the
label structure. Set False to reduce memory use.
:param: bool base_alignment: when True allows to align text label to the baseline.
This is helpful when two or more labels need to be aligned to the same baseline"""
This is helpful when two or more labels need to be aligned to the same baseline
:param tuple(int, str): tuple with tab character replace information. When (4, " ")
will indicate a tab replacement of 4 spaces, defaults to 4 spaces by tab character"""

# pylint: disable=unused-argument, too-many-instance-attributes, too-many-locals, too-many-arguments
# pylint: disable=too-many-branches, no-self-use, too-many-statements
Expand Down Expand Up @@ -96,6 +98,7 @@ def __init__(
save_text=True, # can reduce memory use if save_text = False
scale=1,
base_alignment=False,
tab_replacement=(4, " "),
**kwargs,
):

Expand All @@ -121,7 +124,8 @@ def __init__(
) # the local_group will always stay in the self Group

self._font = font
self._text = text
self.tab_text = tab_replacement[1] * tab_replacement[0]
self._text = self.tab_text.join(text.split("\t"))

# Create the two-color palette
self.palette = displayio.Palette(2)
Expand Down Expand Up @@ -150,6 +154,7 @@ def __init__(
save_text=save_text,
scale=scale,
base_alignment=base_alignment,
tab_replacement=tab_replacement,
)

def _reset_text(
Expand All @@ -169,6 +174,7 @@ def _reset_text(
save_text=None,
scale=None,
base_alignment=None,
tab_replacement=None,
):

# Store all the instance variables
Expand Down Expand Up @@ -198,13 +204,14 @@ def _reset_text(
self._save_text = save_text
if base_alignment is not None:
self.base_alignment = base_alignment

if tab_replacement is not None:
self.tab_replacement = tab_replacement
# if text is not provided as a parameter (text is None), use the previous value.
if (text is None) and self._save_text:
text = self._text

if self._save_text: # text string will be saved
self._text = text
self._text = self.tab_text.join(text.split("\t"))
else:
self._text = None # save a None value since text string is not saved

Expand Down Expand Up @@ -239,7 +246,7 @@ def _reset_text(
loose_box_y,
loose_y_offset,
) = self._text_bounding_box(
text,
self._text,
self._font,
self._line_spacing,
) # calculate the box size for a tight and loose backgrounds
Expand All @@ -262,7 +269,7 @@ def _reset_text(
# Place the text into the Bitmap
self._place_text(
self.bitmap,
text,
self._text,
self._font,
self._line_spacing,
self._padding_left - x_offset,
Expand Down Expand Up @@ -632,6 +639,7 @@ def text(self):

@text.setter # Cannot set color or background color with text setter, use separate setter
def text(self, new_text):
new_text = self.tab_text.join(new_text.split("\t"))
self._reset_text(text=new_text, scale=self.scale)

@property
Expand Down
10 changes: 8 additions & 2 deletions adafruit_display_text/label.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ class Label(displayio.Group):
containing x,y pixel coordinates.
:param int scale: Integer value of the pixel scaling
:param bool base_alignment: when True allows to align text label to the baseline.
This is helpful when two or more labels need to be aligned to the same baseline"""
This is helpful when two or more labels need to be aligned to the same baseline
:param tuple(int, str): tuple with tab character replace information. When (4, " ")
will indicate a tab replacement of 4 spaces, defaults to 4 spaces by tab character"""

# pylint: disable=too-many-instance-attributes, too-many-locals
# This has a lot of getters/setters, maybe it needs cleanup.
Expand All @@ -86,14 +88,17 @@ def __init__(
anchored_position=None,
scale=1,
base_alignment=False,
tab_replacement=(4, " "),
**kwargs
):
if not max_glyphs and not text:
raise RuntimeError("Please provide a max size, or initial text")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could save a line and just put the text = " ".join(text.split("\t")) before the if not max_glyphs: statement.

It does this calculation either way, so just do it once and then do the max_glyphs check.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback, good point, I will change it and re-do the test just to be 100% sure. Thanks @kmatch98 :)

self.tab_text = tab_replacement[1] * tab_replacement[0]
text = self.tab_text.join(text.split("\t"))
if not max_glyphs:
max_glyphs = len(text)
# add one to max_size for the background bitmap tileGrid

# add one to max_size for the background bitmap tileGrid
# instance the Group
# self Group will contain a single local_group which contains a Group (self.local_group)
# which contains a TileGrid
Expand Down Expand Up @@ -386,6 +391,7 @@ def text(self):

@text.setter
def text(self, new_text):
new_text = self.tab_text.join(new_text.split("\t"))
try:
current_anchored_position = self.anchored_position
self._update_text(str(new_text))
Expand Down