Add # -*- coding: utf-8 -*- to the top of all SageNB .py files

[qed777]

Adding the pragma now to all Python files in SageNB may prevent some of the increasingly common docbuild errors raised when we build the reference manual.

CC: @TimDumol @sagetrac-mvngu

Component: notebook

Author: Tim Dumol

Reviewer: Mitesh Patel

Merged: sagenb-0.7

Issue created by migration from https://trac.sagemath.org/ticket/8000

[qed777]

comment:1

Minh -- Is this OK? Shall we make another ticket to update the whole Sage library?

[qed777]

comment:2

Replying to @qed777:

Minh -- Is this OK? Shall we make another ticket to update the whole Sage library?

In particular, post-#7249, we've got non-ASCII Unicode characters in doctests.

[sagetrac-mvngu]

comment:3

Replying to @qed777:

Minh -- Is this OK? Shall we make another ticket to update the whole Sage library?

I'm not sure about this, although I can clearly see the benefit of it. On the one hand, this could be further discouragement to people who want to start with Sage development. Could you send an email to sage-devel polling people about this issue? I mean something along the line of, "Should each source file have the character encoding preamble # -- coding: utf-8 -- ?". Also see #7999 relating to one file in the Sage library.

[qed777]

Description changed:

--- 
+++ 
@@ -1,10 +1,2 @@
-Adding the pragma now to all Python files in SageNB should prevent the increasingly common docbuild errors 
+Adding the pragma now to all Python files in SageNB may prevent some of the increasingly common docbuild errors raised when we build the reference manual.
 
-```
-reading sources... [ 99%] sagenb/notebook/worksheet
-Sphinx error:
-'utf8' codec can't decode bytes in position 420-422: invalid data
-```
-raised when we build the reference manual.
-
-This is partly a followup to #7249, I think.

[qed777]

comment:4

Actually, it seems that # -*- coding: utf-8 -*- was already at the top of worksheet.py.

[qed777]

comment:5

Perhaps a different coding slipped in?

[qed777]

comment:6

Replying to @qed777:

Perhaps a different coding slipped in?

It turns out that we could fix this problem (cf. #7249) by making the docstring a unicode or raw string (e.g., """ --> u""" or r""").

[TimDumol]

This adds the coding directive

[TimDumol]

comment:7

Attachment: trac_8000-utf-8-coding-directive.patch.gz

This patch should do the trick.

[TimDumol]

Author: Tim Dumol