bpo-30095: Customizing HTMLCalendar #1439

oz123 · 2017-05-03T19:15:40Z

as discussed here http://bugs.python.org/issue30095

Unfortunately, this whole module isn't pep8 compatible, I didn't touch where I am not supposed to touch, so pep8 won't passed here.

The HTMLCalendar has now multiple class attributes for styling the calendar. In order to retain backwards compatibility style names are not changed. The new attributes are: weekday_head_styles month_head_styles = ("month",) year_head_styles = ("year",) year_styles = ("year",) This are added to the previously existing styles, which where scattered around the code hard coded or as class attributes: month style day styles noday style The relevant methods have been modified to use these attributes. If you want a calendar where elements has multiple CSS attributes you can now do the following: >>> my_styles = HTMLCalendar.cssclasses[:] >>> my_stelys = " ".join((s, "black text-centered")) for s in my_styles] class MyCalendar(HTMLCalendar): cssclasses = styles month_head_styles = "month-title text-bold" This implementation simply replaces hard coded string with class attributes (which are also single strings albite the attribute names which are in plural).

mention-bot · 2017-05-03T19:15:42Z

@oz123, thanks for your PR! By analyzing the history of the files in this pull request, we identified @doerwalter, @Yhg1s and @birkenfeld to be potential reviewers.

Fix typos, and more class attributes documentation

oz123 · 2017-05-08T21:24:15Z

@doerwalter, I updated the documentation. I would be happy to hear your comments now.

csabella · 2017-05-10T16:38:33Z

Doc/library/calendar.rst

      sheet should be used. *encoding* specifies the encoding to be used for the
      output (defaulting to the system default encoding).

+   :class:`HTMLCalendar` has the following attribute you can override to customize the style of your calender:


attribute -> attributes
Try not to use 'you' or 'your'.

csabella · 2017-05-10T16:38:38Z

Doc/library/calendar.rst

+
+  .. attribute:: cssclasses
+
+    Is a list of CSS styles used for each weekday. The default style list is::


Not sure this should start with 'is'. The calendar attributes on this page all start with a subject, such as 'An array'.

csabella · 2017-05-10T16:38:41Z

Doc/library/calendar.rst

+
+        cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
+
+    Note, that the length of this list must be 7 items.


I don't think this needs a comma after Note.

csabella · 2017-05-10T16:38:45Z

Doc/library/calendar.rst

+
+  .. attribute:: noday_classes
+
+     The CSS class for a week day occuring in previous or the coming month.


occuring -> occurring.

week day -> weekday

"in the previous or coming month"

csabella · 2017-05-10T16:38:48Z

Doc/library/calendar.rst

+
+     Is a list of CSS styles used for each weekday. The default style list is
+
+     the same as ``HTMLCalendar.cssclassess``.


Not sure about starting with 'is'.

These two lines gave odd spacing when I looked at the html rendered.

There's an extra 's' at the end of HTMLCalendar.cssclasses.

csabella · 2017-05-10T16:39:11Z

Doc/library/calendar.rst

+
+  .. attribute:: month_head_classes
+
+     A space separted list of styles for the month head, for example::


separted -> separated

csabella · 2017-05-10T16:39:16Z

Doc/library/calendar.rst

+
+  .. attribute:: month_classes
+
+     a space separted list of styles for the whole table.


Capitalize 'a'.

separted -> separated

Also, there is a blank line in between the description and the default value for this, year_classes and year_head_classes.

csabella · 2017-05-10T16:39:46Z

Doc/library/calendar.rst

+  .. attribute:: year_classes
+
+     a space separted list of styles for the table when formatting the year
+     as a table of tables (see: ``HTMLCalendar.formatyear``).


Capitalize 'a'.

separted -> separated

csabella · 2017-05-10T16:39:49Z

Doc/library/calendar.rst

+
+  .. attribute:: year_head_classes
+
+     a space separted list of styles for the table head when formatting the year as a table of tables (see: ``HTMLCalendar.formatyear``).


capitalize 'a'

separted -> separated

csabella · 2017-05-10T16:45:35Z

When I looked at the html page for the docs, the indentation was off compared to the section before your changes (I used 'make html' to be able to view it). I'm also wondering about the name of 'cssclasses'. Since the year and month ones have year and month in the name, maybe this should too?

oz123 · 2017-05-10T17:46:09Z

@csabella Thanks for the thorough review. I am embarrassed there are so many spelling errors...

I would prefer to rename the cssclasses attribute to weekday_classes, but I was afraid somebody is already using it with that name.
If there is no objection to that, I would rename that attribute. I will correct the spelling errors as soon as possible.

csabella · 2017-05-10T18:51:56Z

@oz123 Please don't be embarrassed about it. I probably should have just asked you to spellcheck it instead of commenting on each one. Sorry about that.

As far as the attribute name, maybe @doerwalter could help resolve that. I just found it inconsistent when reading the doc, so I wanted to ask about it.

Thanks @csabllea

oz123 · 2017-05-10T19:15:24Z

@doerwalter what do you think about renaming the attribute HTMLCalendar.cssclassesto HTMLCalendar.weekday_styles`?

csabella · 2017-05-10T19:39:43Z

@oz123 I looked at the html again and still had the issue with the odd indentation. Looking at the source, I noticed you used 4 spaces (or tab) to indent. The docs use 3 spaces (and no tabs) as the standard with an 80 character limit.

Here's the reference in the dev guide for formatting the docs:
https://docs.python.org/devguide/documenting.html#style-guide

oz123 · 2017-05-10T19:56:36Z

@csabella fixed the white space. Can you check now?

csabella · 2017-05-10T22:10:15Z

Doc/library/calendar.rst

      output (defaulting to the system default encoding).

+   :class:`HTMLCalendar` has the following attributes you can override to
+   customize the style of your calender:


calender -> calendar

csabella · 2017-05-10T22:10:17Z

Doc/library/calendar.rst

+
+         cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
+
+      Note that the length of this list must be 7 items.


Other places in this page use 'seven' instead of '7'.

csabella · 2017-05-10T22:10:19Z

Doc/library/calendar.rst

+
+   .. attribute:: noday_classes
+
+      The CSS class for a week day occurring in previous or the coming month.


week day -> weekday

try "in the previous or coming month"

doerwalter · 2017-05-31T16:30:15Z

Also you might want to add an appropriate description of the new features to Doc/whatsnew/3.7.rst.

oz123 · 2017-06-01T04:54:33Z

@doerwalter I added the changes you suggested.
I really hope these additions to HTMLCalendar will be useful for others too.
Thank you for all the support and suggestions until now.

doerwalter · 2017-06-01T14:00:13Z

Doc/library/calendar.rst


      Note that the length of this list must be seven items.

+   .. versionadded:: 3.7


The .. versionadded:: 3.7 should go inside the .. attribute:: block (after the description), i.e.

.. attribute:: cssclass_noday The CSS class for a weekday occurring in the previous or coming month. .. versionadded:: 3.7

Note that you can create the documentation yourself to check the result via make html in the Doc directory (you need Sphinx for that)

doerwalter · 2017-06-01T14:11:32Z

Doc/library/calendar.rst

+   .. versionadded:: 3.7
   .. attribute:: cssclass_month_head

      The month's head CSS class. The default value is ``"month"``.


You could add a reference to formatmonthname here, i.e.:

The month's head CSS class (see :meth:`formatmonthname`). The default value is ``"month"``.

doerwalter · 2017-06-01T14:12:39Z

Doc/library/calendar.rst

+   .. versionadded:: 3.7
   .. attribute:: cssclass_month

      The CSS class for the whole month's table. The default value is ``"month"``.


You could add a reference to formatmonth here, i.e.:

The CSS class for the whole month's table (see :meth:`formatmonth`). The default value is ``"month"``.

doerwalter · 2017-06-01T14:49:11Z

Doc/whatsnew/3.7.rst

+customisation the CSS classes in the produced HTML calendar.
+(Contributed by Oz Tiram in :issue:`30095`.)
+
+


IMHO this should be something like this:

calendar -------- CSS classes used by :class:`~calendar.HTMLCalendar` can now be customized by subclassing :class:`~calendar.HTMLCalendar` and overwriting certain class attributes. (Contributed by Oz Tiram in :issue:`30095`.)

doerwalter · 2017-06-01T15:05:07Z

Lib/test/test_calendar.py

+    def test_formatweek(self):
+        weeks = self.cal.monthdays2calendar(2017,5)
+        self.assertIn('class="wed text-nowrap"', self.cal.formatweek(weeks[0]))
+    def test_format_year(self):


There's a newline missing here.

Fixed in 45d68c2

doerwalter · 2017-06-01T16:03:15Z

I pushed a small documentation fix to your branch.

oz123 · 2017-06-01T16:06:52Z

@doerwalter WOW! I didn't know you can push to a pull request! That is cool.

doerwalter · 2017-06-01T16:13:55Z

@oz123 That's new for me too: see https://docs.python.org/devguide/gitbootcamp.html

doerwalter · 2017-06-02T14:54:40Z

I've renamed cssclass_weekday_head to cssclasses_weekday_head, since this is a list of names.

I've noticed that there's no test that checks for this configuration. Could you add one? And if there are other tests missing add those too.

…ute.

oz123 · 2017-06-05T15:18:54Z

@doerwalter I think the change you introduce is good. I also added tests to all the class attributes. Hopefully, this is the last iteration.

doerwalter · 2017-06-06T09:41:35Z

OK, your patch is in.

Congratulations and thanks for your contribution to Python.

oz123 added 4 commits April 23, 2017 08:57

Consitent naming

f2609fb

Add test case for subclassing

fe05aac

Add documentation for customizing HTMLCalendar

363e373

the-knights-who-say-ni added the CLA signed label May 3, 2017

Mariatta added the type-feature A feature request or enhancement label May 3, 2017

Documentation updates

4ae2a28

Fix typos, and more class attributes documentation

csabella reviewed May 10, 2017

View reviewed changes

Correct spelling and fix styling

28cfb91

Thanks @csabllea

Format white space to comply with the style guide

02ebee9

oz123 force-pushed the bpo-30095 branch from 0ec215a to 02ebee9 Compare May 10, 2017 20:00

csabella reviewed May 10, 2017

View reviewed changes

Oz N Tiram added 5 commits June 1, 2017 06:34

Fix wrong usage of CSS classes

075d86c

Add documation strings for the HTMLCalendar class attributes

fd2bda3

Mention in which version class attributes were added

1c63cfa

Fix failing test

e4b95a0

Update NEWS and ACKS

2efe925

Merge upstream changes for what is new in 3.7

712cf53

doerwalter reviewed Jun 1, 2017

View reviewed changes

oz123 and others added 4 commits June 1, 2017 17:40

Fix versionadded directives

c54116e

pep8 white space fixes

45d68c2

Merge branch 'master' into bpo-30095

29a4661

Move HTMLCalendar example into class description block.

6571d3f

doerwalter added 2 commits June 2, 2017 16:42

Whitespace.

496c194

Update variable name that contains a list of CSS classes to be plural.

2eae99d

doerwalter and others added 3 commits June 2, 2017 17:10

Avoid link to the start of the class description.

7ffa9cc

In the attribute description refer to the method that uses the attrib…

f0f6100

…ute.

Complete all tests for HTMLCalendar class attributes

3b4529d

doerwalter merged commit 8b7a4cc into python:master Jun 6, 2017


		.. attribute:: cssclasses

		Is a list of CSS styles used for each weekday. The default style list is::


		cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]

		Note, that the length of this list must be 7 items.


		.. attribute:: noday_classes

		The CSS class for a week day occuring in previous or the coming month.


		Is a list of CSS styles used for each weekday. The default style list is

		the same as ``HTMLCalendar.cssclassess``.


		.. attribute:: month_head_classes

		A space separted list of styles for the month head, for example::


		.. attribute:: month_classes

		a space separted list of styles for the whole table.


		.. attribute:: year_head_classes

		a space separted list of styles for the table head when formatting the year as a table of tables (see: ``HTMLCalendar.formatyear``).


		cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]

		Note that the length of this list must be 7 items.


		.. attribute:: noday_classes

		The CSS class for a week day occurring in previous or the coming month.


		Note that the length of this list must be seven items.

		.. versionadded:: 3.7

		customisation the CSS classes in the produced HTML calendar.
		(Contributed by Oz Tiram in :issue:`30095`.)

Uh oh!

bpo-30095: Customizing HTMLCalendar #1439

bpo-30095: Customizing HTMLCalendar #1439

Uh oh!

Conversation

oz123 commented May 3, 2017

Uh oh!

mention-bot commented May 3, 2017

Uh oh!

oz123 commented May 8, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csabella May 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csabella commented May 10, 2017

Uh oh!

oz123 commented May 10, 2017

Uh oh!

csabella commented May 10, 2017

Uh oh!

oz123 commented May 10, 2017

Uh oh!

csabella commented May 10, 2017

Uh oh!

oz123 commented May 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

doerwalter commented May 31, 2017

Uh oh!

oz123 commented Jun 1, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

doerwalter commented Jun 1, 2017

Uh oh!

oz123 commented Jun 1, 2017

Uh oh!

doerwalter commented Jun 1, 2017

Uh oh!

doerwalter commented Jun 2, 2017

Uh oh!

oz123 commented Jun 5, 2017

Uh oh!

doerwalter commented Jun 6, 2017

Uh oh!

Reviewers

Assignees

Labels

csabella May 10, 2017 •

edited

Loading