maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Minor spelling fixes

Browse source 
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
This commit is contained in:
Jason Davies 2010-11-13 11:28:42 +00:00 • committed by Armin Ronacher
parent 2ac1b7d438
commit ed517c7215
3 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CHANGES
View file

@ -45,7 +45,7 @@ Released on July 27th 2010, codename Whisky
- after request functions are now called in reverse order of - after request functions are now called in reverse order of
registration. registration.
- OPTIONS is now automatically implemented by Flask unless the - OPTIONS is now automatically implemented by Flask unless the
application explictly adds 'OPTIONS' as method to the URL rule. application explicitly adds 'OPTIONS' as method to the URL rule.
In this case no automatic OPTIONS handling kicks in. In this case no automatic OPTIONS handling kicks in.
- static rules are now even in place if there is no static folder - static rules are now even in place if there is no static folder
for the module. This was implemented to aid GAE which will for the module. This was implemented to aid GAE which will
@ -65,7 +65,7 @@ Released on July 27th 2010, codename Whisky
- added signalling support based on blinker. This feature is currently - added signalling support based on blinker. This feature is currently
optional and supposed to be used by extensions and applications. If optional and supposed to be used by extensions and applications. If
you want to use it, make sure to have `blinker`_ installed. you want to use it, make sure to have `blinker`_ installed.
- refactored the way url adapters are created. This process is now - refactored the way URL adapters are created. This process is now
fully customizable with the :meth:`~flask.Flask.create_url_adapter` fully customizable with the :meth:`~flask.Flask.create_url_adapter`
method. method.
- modules can now register for a subdomain instead of just an URL - modules can now register for a subdomain instead of just an URL

2
docs/foreword.rst
View file

@ -106,4 +106,4 @@ Werkzeug and Flask will be ported to Python 3 as soon as a solution for
WSGI is found, and we will provide helpful tips how to upgrade existing WSGI is found, and we will provide helpful tips how to upgrade existing
applications to Python 3. Until then, we strongly recommend using Python applications to Python 3. Until then, we strongly recommend using Python
2.6 and 2.7 with activated Python 3 warnings during development, as well 2.6 and 2.7 with activated Python 3 warnings during development, as well
as the unicode literals `__future__` feature. as the Unicode literals `__future__` feature.

28
docs/unicode.rst
View file

@ -1,23 +1,23 @@
Unicode in Flask Unicode in Flask
================ ================
Flask like Jinja2 and Werkzeug is totally unicode based when it comes to Flask like Jinja2 and Werkzeug is totally Unicode based when it comes to
text. Not only these libraries, also the majority of web related Python text. Not only these libraries, also the majority of web related Python
libraries that deal with text. If you don't know unicode so far, you libraries that deal with text. If you don't know Unicode so far, you
should probably read `The Absolute Minimum Every Software Developer should probably read `The Absolute Minimum Every Software Developer
Absolutely, Positively Must Know About Unicode and Character Sets Absolutely, Positively Must Know About Unicode and Character Sets
<http://www.joelonsoftware.com/articles/Unicode.html>`_. This part of the <http://www.joelonsoftware.com/articles/Unicode.html>`_. This part of the
documentation just tries to cover the very basics so that you have a documentation just tries to cover the very basics so that you have a
pleasant experience with unicode related things. pleasant experience with Unicode related things.
Automatic Conversion Automatic Conversion
-------------------- --------------------
Flask has a few assumptions about your application (which you can change Flask has a few assumptions about your application (which you can change
of course) that give you basic and painless unicode support: of course) that give you basic and painless Unicode support:
- the encoding for text on your website is UTF-8 - the encoding for text on your website is UTF-8
- internally you will always use unicode exclusively for text except - internally you will always use Unicode exclusively for text except
for literal strings with only ASCII character points. for literal strings with only ASCII character points.
- encoding and decoding happens whenever you are talking over a protocol - encoding and decoding happens whenever you are talking over a protocol
that requires bytes to be transmitted. that requires bytes to be transmitted.
@ -29,27 +29,27 @@ address documents on servers (so called URIs or URLs). However HTML which
is usually transmitted on top of HTTP supports a large variety of is usually transmitted on top of HTTP supports a large variety of
character sets and which ones are used, are transmitted in an HTTP header. character sets and which ones are used, are transmitted in an HTTP header.
To not make this too complex Flask just assumes that if you are sending To not make this too complex Flask just assumes that if you are sending
unicode out you want it to be UTF-8 encoded. Flask will do the encoding Unicode out you want it to be UTF-8 encoded. Flask will do the encoding
and setting of the appropriate headers for you. and setting of the appropriate headers for you.
The same is true if you are talking to databases with the help of The same is true if you are talking to databases with the help of
SQLAlchemy or a similar ORM system. Some databases have a protocol that SQLAlchemy or a similar ORM system. Some databases have a protocol that
already transmits unicode and if they do not, SQLAlchemy or your other ORM already transmits Unicode and if they do not, SQLAlchemy or your other ORM
should take care of that. should take care of that.
The Golden Rule The Golden Rule
--------------- ---------------
So the rule of thumb: if you are not dealing with binary data, work with So the rule of thumb: if you are not dealing with binary data, work with
unicode. What does working with unicode in Python 2.x mean? Unicode. What does working with Unicode in Python 2.x mean?
- as long as you are using ASCII charpoints only (basically numbers, - as long as you are using ASCII charpoints only (basically numbers,
some special characters of latin letters without umlauts or anything some special characters of latin letters without umlauts or anything
fancy) you can use regular string literals (``'Hello World'``). fancy) you can use regular string literals (``'Hello World'``).
- if you need anything else than ASCII in a string you have to mark - if you need anything else than ASCII in a string you have to mark
this string as unicode string by prefixing it with a lowercase `u`. this string as Unicode string by prefixing it with a lowercase `u`.
(like ``u'Hänsel und Gretel'``) (like ``u'Hänsel und Gretel'``)
- if you are using non-unicode characters in your Python files you have - if you are using non-Unicode characters in your Python files you have
to tell Python which encoding your file uses. Again, I recommend to tell Python which encoding your file uses. Again, I recommend
UTF-8 for this purpose. To tell the interpreter your encoding you can UTF-8 for this purpose. To tell the interpreter your encoding you can
put the ``# -*- coding: utf-8 -*-`` into the first or second line of put the ``# -*- coding: utf-8 -*-`` into the first or second line of
@ -61,21 +61,21 @@ Encoding and Decoding Yourself
------------------------------ ------------------------------
If you are talking with a filesystem or something that is not really based If you are talking with a filesystem or something that is not really based
on unicode you will have to ensure that you decode properly when working on Unicode you will have to ensure that you decode properly when working
with unicode interface. So for example if you want to load a file on the with Unicode interface. So for example if you want to load a file on the
filesystem and embed it into a Jinja2 template you will have to decode it filesystem and embed it into a Jinja2 template you will have to decode it
from the encoding of that file. Here the old problem that text files do from the encoding of that file. Here the old problem that text files do
not specify their encoding comes into play. So do yourself a favour and not specify their encoding comes into play. So do yourself a favour and
limit yourself to UTF-8 for text files as well. limit yourself to UTF-8 for text files as well.
Anyways. To load such a file with unicode you can use the built-in Anyways. To load such a file with Unicode you can use the built-in
:meth:`str.decode` method:: :meth:`str.decode` method::
def read_file(filename, charset='utf-8'): def read_file(filename, charset='utf-8'):
with open(filename, 'r') as f: with open(filename, 'r') as f:
return f.read().decode(charset) return f.read().decode(charset)
To go from unicode into a specific charset such as UTF-8 you can use the To go from Unicode into a specific charset such as UTF-8 you can use the
:meth:`unicode.encode` method:: :meth:`unicode.encode` method::
def write_file(filename, contents, charset='utf-8'): def write_file(filename, contents, charset='utf-8'):