diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2021-03-31 18:18:55 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephenfin@redhat.com> | 2021-04-01 14:16:22 +0000 |
| commit | f00e14f400193e35c8040bc93ac6c509fa2bb4dc (patch) | |
| tree | 0913487eeb0ea0db7305494592821d601d49fa52 | |
| parent | 87e682867886bddd10f1dc9c4a174603414e0480 (diff) | |
| download | python-openstackclient-f00e14f400193e35c8040bc93ac6c509fa2bb4dc.tar.gz | |
hacking: Remove references to encoding
This is no longer an issue in our new Python 3-only world.
Change-Id: I25c31a0b7f76a253499d9713ba48fd7ba7168450
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
| -rw-r--r-- | HACKING.rst | 48 |
1 files changed, 1 insertions, 47 deletions
diff --git a/HACKING.rst b/HACKING.rst index b5fbad3c..432d19f4 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -32,7 +32,7 @@ use the alternate 4 space indent. With the first argument on the succeeding line all arguments will then be vertically aligned. Use the same convention used with other data structure literals and terminate the method call with the last argument line ending with a comma and the closing paren on its own -line indented to the starting line level. +line indented to the starting line level. :: unnecessarily_long_function_name( 'string one', @@ -40,49 +40,3 @@ line indented to the starting line level. kwarg1=constants.ACTIVE, kwarg2=['a', 'b', 'c'], ) - -Text encoding -------------- - -Note: this section clearly has not been implemented in this project yet, it is -the intention to do so. - -All text within python code should be of type 'unicode'. - - WRONG: - - >>> s = 'foo' - >>> s - 'foo' - >>> type(s) - <type 'str'> - - RIGHT: - - >>> u = u'foo' - >>> u - u'foo' - >>> type(u) - <type 'unicode'> - -Transitions between internal unicode and external strings should always -be immediately and explicitly encoded or decoded. - -All external text that is not explicitly encoded (database storage, -commandline arguments, etc.) should be presumed to be encoded as utf-8. - - WRONG: - - infile = open('testfile', 'r') - mystring = infile.readline() - myreturnstring = do_some_magic_with(mystring) - outfile.write(myreturnstring) - - RIGHT: - - infile = open('testfile', 'r') - mystring = infile.readline() - mytext = mystring.decode('utf-8') - returntext = do_some_magic_with(mytext) - returnstring = returntext.encode('utf-8') - outfile.write(returnstring) |
