I’m trying to convert file content from Windows-1251 (Cyrillic) to Unicode with Python. I found this function, but it doesn’t work.
#!/usr/bin/env python
import os
import sys
import shutil
def convert_to_utf8(filename):
# gather the encodings you think that the file may be
# encoded inside a tuple
encodings = ('windows-1253', 'iso-8859-7', 'macgreek')
# try to open the file and exit if some IOError occurs
try:
f = open(filename, 'r').read()
except Exception:
sys.exit(1)
# now start iterating in our encodings tuple and try to
# decode the file
for enc in encodings:
try:
# try to decode the file with the first encoding
# from the tuple.
# if it succeeds then it will reach break, so we
# will be out of the loop (something we want on
# success).
# the data variable will hold our decoded text
data = f.decode(enc)
break
except Exception:
# if the first encoding fail, then with the continue
# keyword will start again with the second encoding
# from the tuple an so on.... until it succeeds.
# if for some reason it reaches the last encoding of
# our tuple without success, then exit the program.
if enc == encodings[-1]:
sys.exit(1)
continue
# now get the absolute path of our filename and append .bak
# to the end of it (for our backup file)
fpath = os.path.abspath(filename)
newfilename = fpath + '.bak'
# and make our backup file with shutil
shutil.copy(filename, newfilename)
# and at last convert it to utf-8
f = open(filename, 'w')
try:
f.write(data.encode('utf-8'))
except Exception, e:
print e
finally:
f.close()
How can I do that?
Thank you
Chilledrat
2,5933 gold badges29 silver badges38 bronze badges
asked Apr 27, 2011 at 15:55
2
import codecs
f = codecs.open(filename, 'r', 'cp1251')
u = f.read() # now the contents have been transformed to a Unicode string
out = codecs.open(output, 'w', 'utf-8')
out.write(u) # and now the contents have been output as UTF-8
Is this what you intend to do?
answered Apr 27, 2011 at 16:15
buruzaemonburuzaemon
3,7991 gold badge22 silver badges44 bronze badges
3
This is just a guess, since you didn’t specify what you mean by «doesn’t work».
If the file is being generated properly but appears to contain garbage characters, likely the application you’re viewing it with does not recognize that it contains UTF-8. You need to add a BOM to the beginning of the file — the 3 bytes 0xEF,0xBB,0xBF
(unencoded).
answered Apr 27, 2011 at 16:07
Mark RansomMark Ransom
295k40 gold badges388 silver badges616 bronze badges
0
If you use the codecs
module to open the file, it will do the conversion to Unicode for you when you read from the file. E.g.:
import codecs
f = codecs.open('input.txt', encoding='cp1251')
assert isinstance(f.read(), unicode)
This only makes sense if you’re working with the file’s data in Python. If you’re trying to convert a file from one encoding to another on the filesystem (which is what the script you posted tries to do), you’ll have to specify an actual encoding, since you can’t write a file in «Unicode».
answered Apr 27, 2011 at 16:02
Will McCutchenWill McCutchen
13k3 gold badges43 silver badges43 bronze badges
7
На практике в реальных проектах Data Science часто приходится сталкиваться с чтением датасетов, а также записывать добытую в ходе вычислений информацию в файлы. Сегодня мы расскажем о работе с файлами в Python: чтение и запись, проблема с кодировками, добавление значений в конец файла, временные папки и файлы.
Открываем, а затем читаем или записываем
Предположим, у нас имеется файл, который нужно прочитать в Python. Для этого можно воспользоваться функцией open внутри контекстного менеджера:
with open('file.txt') as f: data = f.read() # содержимое файла
Таким же образом можно записать информацию в файл, указав w
в качестве аргумента:
text = 'Hello' with open('file.txt', 'w') as f: f.write(text)
Отметим некоторые особенности данной функции. Во-первых, для чтения файла мы не указывали никаких аргументов кроме имени файла, поскольку по умолчанию уже стоит режим чтения. Мы также не указывали явно, что это именно текстовый файл, а не бинарный, так как это тоже стоит по умолчанию. Для чтения и записи бинарных файлов добавляется b
, например, rb
или wb
.
Во-вторых, мы использовали функцию open в контекстном менеджере. Можно обойтись и без него, но тогда после чтения или записи следует закрыть файл.
f = open('file.txt') f.read() f.close()
На открытие файла Python выделяет память, поэтому, чтобы избежать ее утечки, рекомендуется закрывать файлы.
Чтение файла с разной кодировкой
На многих операционных системах Python в качестве стандарта кодирования использует UTF-8, который также поддерживает кириллицу. Тем не менее, часто можно столкнуться с проблемами неправильной кодировки и получить распространенную ошибку вроде этой:
>>> f = open('somefile.txt', encoding='ascii') >>> f.read() Traceback (most recent call last): File "<stdin>", line 1, in <module> File "/usr/local/lib/Python3.8/encodings/ascii.py", line 26, in decode return codecs.ascii_decode(input, self.errors)[0] UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 12: ordinal not in range(128))
В примере указана кодировка ASCII, но файл закодирован в другом формате, поэтому и возникает такая ошибка. Решить ее можно тремя способами:
- Указать
erorr=replace
, который заменит нераспознанные символы знаком?
:>>> f = open('somefile.txt', encoding='ascii', errors='replace') >>> f.read() 'H?llo py?ho?-school!'
- Указать
erorr=ignore
, который проигнорирует нераспознанные символы:>>> f = open('somefile.txt', encoding='ascii', errors='replace') >>> f.read() 'Hllo pyho-school!'
- Указать правильную кодировку. Если текст на русском языке, то можно посмотреть кодировки с поддержкой кириллицы, которые есть в документации Python. Например, явно указать UTF-8 или cp1251:
f = open('somefile.txt', encoding='utf-8') # или cp1251 f = open('somefile.txt', encoding='cp1251')
Добавление в конец и запрет открытия файлов
Как мы уже отметили ранее, для записи текстового файла добавляется аргумент w
. Но если вызвать метод write, он перепишет весь файл. Во многих случаях требуется добавить данные в конец файла. Тогда используется a
вместо w
:
text2 = 'world' with open('file.txt', 'a') as f: f.write(text) # Helloworld
Если файла не существует, то при a
и при w
он будет создан. Но чтобы не трогать существующие файлы, а создать новый, передается параметр x
:
# 'x' не даст возможности открыть файл, так как он существует >>> with open('file.txt', 'x') as f: ... f.write(text2) FileExistsError Traceback (most recent call last) FileExistsError: [Errno 17] File exists: 'file.txt' # Поскольку file2.txt не существует, все OK >>> with open('file2.txt', 'x') as f: ... f.write(text2)
Временные файлы
Иногда бывает, что требуется создать файл или папку внутри Python-программы, а после ее закрытия их нужно удалить. Тогда пригодится стандартный модуль tempfile. Например, класс TemporaryFile
создаст временный файл, который удалится после закрытия. Ниже пример в Python.
>>> from tempfile import TemporaryFile >>> f = TemporaryFile("w+t") >>> f.write("hello") >>> f.seek(0) >>> f.read() 'hello' >>> f.close() # файл уничтожается # либо в контекстном менеджере f.write(text2)
Обратите внимание на 3 вещи. Первое, мы явно передаем "w+t"
, чтобы записать как текстовый файл, поскольку по умолчанию стоит "w+b"
для бинарных файлов. Второе, метод seek(0)
используется для перехода на самый первый символ, поскольку чтение происходит с текущего указателя, а он стоит в конце (после буквы ‘o’ в слове ‘hello’). Поэтому не стоит переживать, что мы можем стереть предыдущую запись:
>>> f.seek(5) # переходим в конец >>> f.read() '' >>> f.write("world") 5 >>> f.seek(0) # переходим в начало >>> f.read() 'helloworld'
Третье, файл TemporaryFile
невидим для файловой системы, он используется только внутри Python, поэтому извне будет трудно его найти.
Именованные временные файлы
А вот объекты класса NamedTemporaryFile
будут видны файловой системе, и найти месторасположение можно с помощью атрибута name
:
>>> from tempfile import NamedTemporaryFile >>> f = NamedTemporaryFile("w+t") >>> f.name '/tmp/tmp60djsgli' >>> f.close()
Как можно заметить, файл называется tmp60djsgli
. Для удобства можно явно указать его название и формат:
>>> f = NamedTemporaryFile("w+t", prefix="myfile", suffix=".txt") >>> f.name '/tmp/myfile7mxae0fi.txt'
Временные папки
Кроме временных файлов можно создавать временные папки. Для этого используется класс TemporaryDirectory
:
>>> from tempfile import TemporaryDirectory >>> d = TemporaryDirectory() >>> d.name '/tmp/tmp5eadqzz5'
Он также принимает в качестве аргументов prefix
и suffix
, а также может использоваться внутри контекстного менеджера Python.
В следующей статье поговорим о взаимодействии файловой системы и Python. А получить практические навыки работы с файлами на реальных проектах Data Science вы сможете на наших курсах по Python в лицензированном учебном центре обучения и повышения квалификации IT-специалистов в Москве.
Источники
- https://docs.python.org/3/library/functions.html#open
- https://docs.python.org/3/library/tempfile.html
Source code: Lib/codecs.py
This module defines base classes for standard Python codecs (encoders and
decoders) and provides access to the internal Python codec registry, which
manages the codec and error handling lookup process. Most standard codecs
are text encodings, which encode text to bytes,
but there are also codecs provided that encode text to text, and bytes to
bytes. Custom codecs may encode and decode between arbitrary types, but some
module features are restricted to use specifically with
text encodings, or with codecs that encode to
bytes
.
The module defines the following functions for encoding and decoding with
any codec:
-
codecs.
encode
(obj, encoding=’utf-8′, errors=’strict’)¶ -
Encodes obj using the codec registered for encoding.
Errors may be given to set the desired error handling scheme. The
default error handler is'strict'
meaning that encoding errors raise
ValueError
(or a more codec specific subclass, such as
UnicodeEncodeError
). Refer to Codec Base Classes for more
information on codec error handling.
-
codecs.
decode
(obj, encoding=’utf-8′, errors=’strict’)¶ -
Decodes obj using the codec registered for encoding.
Errors may be given to set the desired error handling scheme. The
default error handler is'strict'
meaning that decoding errors raise
ValueError
(or a more codec specific subclass, such as
UnicodeDecodeError
). Refer to Codec Base Classes for more
information on codec error handling.
The full details for each codec can also be looked up directly:
-
codecs.
lookup
(encoding)¶ -
Looks up the codec info in the Python codec registry and returns a
CodecInfo
object as defined below.Encodings are first looked up in the registry’s cache. If not found, the list of
registered search functions is scanned. If noCodecInfo
object is
found, aLookupError
is raised. Otherwise, theCodecInfo
object
is stored in the cache and returned to the caller.
-
class
codecs.
CodecInfo
(encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)¶ -
Codec details when looking up the codec registry. The constructor
arguments are stored in attributes of the same name:-
name
¶ -
The name of the encoding.
-
encode
¶ -
decode
¶ -
The stateless encoding and decoding functions. These must be
functions or methods which have the same interface as
theencode()
anddecode()
methods of Codec
instances (see Codec Interface).
The functions or methods are expected to work in a stateless mode.
-
incrementalencoder
¶ -
incrementaldecoder
¶ -
Incremental encoder and decoder classes or factory functions.
These have to provide the interface defined by the base classes
IncrementalEncoder
andIncrementalDecoder
,
respectively. Incremental codecs can maintain state.
-
streamwriter
¶ -
streamreader
¶ -
Stream writer and reader classes or factory functions. These have to
provide the interface defined by the base classes
StreamWriter
andStreamReader
, respectively.
Stream codecs can maintain state.
-
To simplify access to the various codec components, the module provides
these additional functions which use lookup()
for the codec lookup:
-
codecs.
getencoder
(encoding)¶ -
Look up the codec for the given encoding and return its encoder function.
Raises a
LookupError
in case the encoding cannot be found.
-
codecs.
getdecoder
(encoding)¶ -
Look up the codec for the given encoding and return its decoder function.
Raises a
LookupError
in case the encoding cannot be found.
-
codecs.
getincrementalencoder
(encoding)¶ -
Look up the codec for the given encoding and return its incremental encoder
class or factory function.Raises a
LookupError
in case the encoding cannot be found or the codec
doesn’t support an incremental encoder.
-
codecs.
getincrementaldecoder
(encoding)¶ -
Look up the codec for the given encoding and return its incremental decoder
class or factory function.Raises a
LookupError
in case the encoding cannot be found or the codec
doesn’t support an incremental decoder.
-
codecs.
getreader
(encoding)¶ -
Look up the codec for the given encoding and return its
StreamReader
class or factory function.Raises a
LookupError
in case the encoding cannot be found.
-
codecs.
getwriter
(encoding)¶ -
Look up the codec for the given encoding and return its
StreamWriter
class or factory function.Raises a
LookupError
in case the encoding cannot be found.
Custom codecs are made available by registering a suitable codec search
function:
-
codecs.
register
(search_function)¶ -
Register a codec search function. Search functions are expected to take one
argument, being the encoding name in all lower case letters, and return a
CodecInfo
object. In case a search function cannot find
a given encoding, it should returnNone
.Note
Search function registration is not currently reversible,
which may cause problems in some cases, such as unit testing or
module reloading.
While the builtin open()
and the associated io
module are the
recommended approach for working with encoded text files, this module
provides additional utility functions and classes that allow the use of a
wider range of codecs when working with binary files:
-
codecs.
open
(filename, mode=’r’, encoding=None, errors=’strict’, buffering=1)¶ -
Open an encoded file using the given mode and return an instance of
StreamReaderWriter
, providing transparent encoding/decoding.
The default file mode is'r'
, meaning to open the file in read mode.Note
Underlying encoded files are always opened in binary mode.
No automatic conversion of'n'
is done on reading and writing.
The mode argument may be any binary mode acceptable to the built-in
open()
function; the'b'
is automatically added.encoding specifies the encoding which is to be used for the file.
Any encoding that encodes to and decodes from bytes is allowed, and
the data types supported by the file methods depend on the codec used.errors may be given to define the error handling. It defaults to
'strict'
which causes aValueError
to be raised in case an encoding error occurs.buffering has the same meaning as for the built-in
open()
function. It
defaults to line buffered.
-
codecs.
EncodedFile
(file, data_encoding, file_encoding=None, errors=’strict’)¶ -
Return a
StreamRecoder
instance, a wrapped version of file
which provides transparent transcoding. The original file is closed
when the wrapped version is closed.Data written to the wrapped file is decoded according to the given
data_encoding and then written to the original file as bytes using
file_encoding. Bytes read from the original file are decoded
according to file_encoding, and the result is encoded
using data_encoding.If file_encoding is not given, it defaults to data_encoding.
errors may be given to define the error handling. It defaults to
'strict'
, which causesValueError
to be raised in case an encoding
error occurs.
-
codecs.
iterencode
(iterator, encoding, errors=’strict’, **kwargs)¶ -
Uses an incremental encoder to iteratively encode the input provided by
iterator. This function is a generator.
The errors argument (as well as any
other keyword argument) is passed through to the incremental encoder.This function requires that the codec accept text
str
objects
to encode. Therefore it does not support bytes-to-bytes encoders such as
base64_codec
.
-
codecs.
iterdecode
(iterator, encoding, errors=’strict’, **kwargs)¶ -
Uses an incremental decoder to iteratively decode the input provided by
iterator. This function is a generator.
The errors argument (as well as any
other keyword argument) is passed through to the incremental decoder.This function requires that the codec accept
bytes
objects
to decode. Therefore it does not support text-to-text encoders such as
rot_13
, althoughrot_13
may be used equivalently with
iterencode()
.
The module also provides the following constants which are useful for reading
and writing to platform dependent files:
-
codecs.
BOM
¶ -
codecs.
BOM_BE
¶ -
codecs.
BOM_LE
¶ -
codecs.
BOM_UTF8
¶ -
codecs.
BOM_UTF16
¶ -
codecs.
BOM_UTF16_BE
¶ -
codecs.
BOM_UTF16_LE
¶ -
codecs.
BOM_UTF32
¶ -
codecs.
BOM_UTF32_BE
¶ -
codecs.
BOM_UTF32_LE
¶ -
These constants define various byte sequences,
being Unicode byte order marks (BOMs) for several encodings. They are
used in UTF-16 and UTF-32 data streams to indicate the byte order used,
and in UTF-8 as a Unicode signature.BOM_UTF16
is either
BOM_UTF16_BE
orBOM_UTF16_LE
depending on the platform’s
native byte order,BOM
is an alias forBOM_UTF16
,
BOM_LE
forBOM_UTF16_LE
andBOM_BE
for
BOM_UTF16_BE
. The others represent the BOM in UTF-8 and UTF-32
encodings.
7.2.1. Codec Base Classes¶
The codecs
module defines a set of base classes which define the
interfaces for working with codec objects, and can also be used as the basis
for custom codec implementations.
Each codec has to define four interfaces to make it usable as codec in Python:
stateless encoder, stateless decoder, stream reader and stream writer. The
stream reader and writers typically reuse the stateless encoder/decoder to
implement the file protocols. Codec authors also need to define how the
codec will handle encoding and decoding errors.
7.2.1.1. Error Handlers¶
To simplify and standardize error handling,
codecs may implement different error handling schemes by
accepting the errors string argument. The following string values are
defined and implemented by all standard Python codecs:
Value | Meaning |
---|---|
'strict' |
Raise UnicodeError (or a subclass);this is the default. Implemented in strict_errors() . |
'ignore' |
Ignore the malformed data and continue without further notice. Implemented in ignore_errors() . |
The following error handlers are only applicable to
text encodings:
Value | Meaning |
---|---|
'replace' |
Replace with a suitable replacement marker; Python will use the official U+FFFD REPLACEMENT CHARACTER for thebuilt-in codecs on decoding, and ‘?’ on encoding. Implemented in replace_errors() . |
'xmlcharrefreplace' |
Replace with the appropriate XML character reference (only for encoding). Implemented in xmlcharrefreplace_errors() . |
'backslashreplace' |
Replace with backslashed escape sequences. Implemented in backslashreplace_errors() . |
'namereplace' |
Replace with N{...} escape sequences(only for encoding). Implemented in namereplace_errors() . |
'surrogateescape' |
On decoding, replace byte with individual surrogate code ranging from U+DC80 toU+DCFF . This code will then be turnedback into the same byte when the 'surrogateescape' error handler is usedwhen encoding the data. (See PEP 383 for more.) |
In addition, the following error handler is specific to the given codecs:
Value | Codecs | Meaning |
---|---|---|
'surrogatepass' |
utf-8, utf-16, utf-32, utf-16-be, utf-16-le, utf-32-be, utf-32-le |
Allow encoding and decoding of surrogate codes. These codecs normally treat the presence of surrogates as an error. |
New in version 3.1: The 'surrogateescape'
and 'surrogatepass'
error handlers.
Changed in version 3.4: The 'surrogatepass'
error handlers now works with utf-16* and utf-32* codecs.
New in version 3.5: The 'namereplace'
error handler.
Changed in version 3.5: The 'backslashreplace'
error handlers now works with decoding and
translating.
The set of allowed values can be extended by registering a new named error
handler:
-
codecs.
register_error
(name, error_handler)¶ -
Register the error handling function error_handler under the name name.
The error_handler argument will be called during encoding and decoding
in case of an error, when name is specified as the errors parameter.For encoding, error_handler will be called with a
UnicodeEncodeError
instance, which contains information about the location of the error. The
error handler must either raise this or a different exception, or return a
tuple with a replacement for the unencodable part of the input and a position
where encoding should continue. The replacement may be eitherstr
or
bytes
. If the replacement is bytes, the encoder will simply copy
them into the output buffer. If the replacement is a string, the encoder will
encode the replacement. Encoding continues on original input at the
specified position. Negative position values will be treated as being
relative to the end of the input string. If the resulting position is out of
bound anIndexError
will be raised.Decoding and translating works similarly, except
UnicodeDecodeError
or
UnicodeTranslateError
will be passed to the handler and that the
replacement from the error handler will be put into the output directly.
Previously registered error handlers (including the standard error handlers)
can be looked up by name:
-
codecs.
lookup_error
(name)¶ -
Return the error handler previously registered under the name name.
Raises a
LookupError
in case the handler cannot be found.
The following standard error handlers are also made available as module level
functions:
-
codecs.
strict_errors
(exception)¶ -
Implements the
'strict'
error handling: each encoding or
decoding error raises aUnicodeError
.
-
codecs.
replace_errors
(exception)¶ -
Implements the
'replace'
error handling (for text encodings only): substitutes'?'
for encoding errors
(to be encoded by the codec), and'ufffd'
(the Unicode replacement
character) for decoding errors.
-
codecs.
ignore_errors
(exception)¶ -
Implements the
'ignore'
error handling: malformed data is ignored and
encoding or decoding is continued without further notice.
-
codecs.
xmlcharrefreplace_errors
(exception)¶ -
Implements the
'xmlcharrefreplace'
error handling (for encoding with
text encodings only): the
unencodable character is replaced by an appropriate XML character reference.
-
codecs.
backslashreplace_errors
(exception)¶ -
Implements the
'backslashreplace'
error handling (for
text encodings only): malformed data is
replaced by a backslashed escape sequence.
-
codecs.
namereplace_errors
(exception)¶ -
Implements the
'namereplace'
error handling (for encoding with
text encodings only): the
unencodable character is replaced by aN{...}
escape sequence.New in version 3.5.
7.2.1.2. Stateless Encoding and Decoding¶
The base Codec
class defines these methods which also define the
function interfaces of the stateless encoder and decoder:
-
Codec.
encode
(input[, errors])¶ -
Encodes the object input and returns a tuple (output object, length consumed).
For instance, text encoding converts
a string object to a bytes object using a particular
character set encoding (e.g.,cp1252
oriso-8859-1
).The errors argument defines the error handling to apply.
It defaults to'strict'
handling.The method may not store state in the
Codec
instance. Use
StreamWriter
for codecs which have to keep state in order to make
encoding efficient.The encoder must be able to handle zero length input and return an empty object
of the output object type in this situation.
-
Codec.
decode
(input[, errors])¶ -
Decodes the object input and returns a tuple (output object, length
consumed). For instance, for a text encoding, decoding converts
a bytes object encoded using a particular
character set encoding to a string object.For text encodings and bytes-to-bytes codecs,
input must be a bytes object or one which provides the read-only
buffer interface – for example, buffer objects and memory mapped files.The errors argument defines the error handling to apply.
It defaults to'strict'
handling.The method may not store state in the
Codec
instance. Use
StreamReader
for codecs which have to keep state in order to make
decoding efficient.The decoder must be able to handle zero length input and return an empty object
of the output object type in this situation.
7.2.1.3. Incremental Encoding and Decoding¶
The IncrementalEncoder
and IncrementalDecoder
classes provide
the basic interface for incremental encoding and decoding. Encoding/decoding the
input isn’t done with one call to the stateless encoder/decoder function, but
with multiple calls to the
encode()
/decode()
method of
the incremental encoder/decoder. The incremental encoder/decoder keeps track of
the encoding/decoding process during method calls.
The joined output of calls to the
encode()
/decode()
method is
the same as if all the single inputs were joined into one, and this input was
encoded/decoded with the stateless encoder/decoder.
7.2.1.3.1. IncrementalEncoder Objects¶
The IncrementalEncoder
class is used for encoding an input in multiple
steps. It defines the following methods which every incremental encoder must
define in order to be compatible with the Python codec registry.
-
class
codecs.
IncrementalEncoder
(errors=’strict’)¶ -
Constructor for an
IncrementalEncoder
instance.All incremental encoders must provide this constructor interface. They are free
to add additional keyword arguments, but only the ones defined here are used by
the Python codec registry.The
IncrementalEncoder
may implement different error handling schemes
by providing the errors keyword argument. See Error Handlers for
possible values.The errors argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of theIncrementalEncoder
object.-
encode
(object[, final])¶ -
Encodes object (taking the current state of the encoder into account)
and returns the resulting encoded object. If this is the last call to
encode()
final must be true (the default is false).
-
reset
()¶ -
Reset the encoder to the initial state. The output is discarded: call
.encode(object, final=True)
, passing an empty byte or text string
if necessary, to reset the encoder and to get the output.
-
getstate
()¶ -
Return the current state of the encoder which must be an integer. The
implementation should make sure that0
is the most common
state. (States that are more complicated than integers can be converted
into an integer by marshaling/pickling the state and encoding the bytes
of the resulting string into an integer).
-
setstate
(state)¶ -
Set the state of the encoder to state. state must be an encoder state
returned bygetstate()
.
-
7.2.1.3.2. IncrementalDecoder Objects¶
The IncrementalDecoder
class is used for decoding an input in multiple
steps. It defines the following methods which every incremental decoder must
define in order to be compatible with the Python codec registry.
-
class
codecs.
IncrementalDecoder
(errors=’strict’)¶ -
Constructor for an
IncrementalDecoder
instance.All incremental decoders must provide this constructor interface. They are free
to add additional keyword arguments, but only the ones defined here are used by
the Python codec registry.The
IncrementalDecoder
may implement different error handling schemes
by providing the errors keyword argument. See Error Handlers for
possible values.The errors argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of theIncrementalDecoder
object.-
decode
(object[, final])¶ -
Decodes object (taking the current state of the decoder into account)
and returns the resulting decoded object. If this is the last call to
decode()
final must be true (the default is false). If final is
true the decoder must decode the input completely and must flush all
buffers. If this isn’t possible (e.g. because of incomplete byte sequences
at the end of the input) it must initiate error handling just like in the
stateless case (which might raise an exception).
-
reset
()¶ -
Reset the decoder to the initial state.
-
getstate
()¶ -
Return the current state of the decoder. This must be a tuple with two
items, the first must be the buffer containing the still undecoded
input. The second must be an integer and can be additional state
info. (The implementation should make sure that0
is the most common
additional state info.) If this additional state info is0
it must be
possible to set the decoder to the state which has no input buffered and
0
as the additional state info, so that feeding the previously
buffered input to the decoder returns it to the previous state without
producing any output. (Additional state info that is more complicated than
integers can be converted into an integer by marshaling/pickling the info
and encoding the bytes of the resulting string into an integer.)
-
setstate
(state)¶ -
Set the state of the encoder to state. state must be a decoder state
returned bygetstate()
.
-
7.2.1.4. Stream Encoding and Decoding¶
The StreamWriter
and StreamReader
classes provide generic
working interfaces which can be used to implement new encoding submodules very
easily. See encodings.utf_8
for an example of how this is done.
7.2.1.4.1. StreamWriter Objects¶
The StreamWriter
class is a subclass of Codec
and defines the
following methods which every stream writer must define in order to be
compatible with the Python codec registry.
-
class
codecs.
StreamWriter
(stream, errors=’strict’)¶ -
Constructor for a
StreamWriter
instance.All stream writers must provide this constructor interface. They are free to add
additional keyword arguments, but only the ones defined here are used by the
Python codec registry.The stream argument must be a file-like object open for writing
text or binary data, as appropriate for the specific codec.The
StreamWriter
may implement different error handling schemes by
providing the errors keyword argument. See Error Handlers for
the standard error handlers the underlying stream codec may support.The errors argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of theStreamWriter
object.-
write
(object)¶ -
Writes the object’s contents encoded to the stream.
-
writelines
(list)¶ -
Writes the concatenated list of strings to the stream (possibly by reusing
thewrite()
method). The standard bytes-to-bytes codecs
do not support this method.
-
reset
()¶ -
Flushes and resets the codec buffers used for keeping state.
Calling this method should ensure that the data on the output is put into
a clean state that allows appending of new fresh data without having to
rescan the whole stream to recover state.
-
In addition to the above methods, the StreamWriter
must also inherit
all other methods and attributes from the underlying stream.
7.2.1.4.2. StreamReader Objects¶
The StreamReader
class is a subclass of Codec
and defines the
following methods which every stream reader must define in order to be
compatible with the Python codec registry.
-
class
codecs.
StreamReader
(stream, errors=’strict’)¶ -
Constructor for a
StreamReader
instance.All stream readers must provide this constructor interface. They are free to add
additional keyword arguments, but only the ones defined here are used by the
Python codec registry.The stream argument must be a file-like object open for reading
text or binary data, as appropriate for the specific codec.The
StreamReader
may implement different error handling schemes by
providing the errors keyword argument. See Error Handlers for
the standard error handlers the underlying stream codec may support.The errors argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of theStreamReader
object.The set of allowed values for the errors argument can be extended with
register_error()
.-
read
([size[, chars[, firstline]]])¶ -
Decodes data from the stream and returns the resulting object.
The chars argument indicates the number of decoded
code points or bytes to return. Theread()
method will
never return more data than requested, but it might return less,
if there is not enough available.The size argument indicates the approximate maximum
number of encoded bytes or code points to read
for decoding. The decoder can modify this setting as
appropriate. The default value -1 indicates to read and decode as much as
possible. This parameter is intended to
prevent having to decode huge files in one step.The firstline flag indicates that
it would be sufficient to only return the first
line, if there are decoding errors on later lines.The method should use a greedy read strategy meaning that it should read
as much data as is allowed within the definition of the encoding and the
given size, e.g. if optional encoding endings or state markers are
available on the stream, these should be read too.
-
readline
([size[, keepends]])¶ -
Read one line from the input stream and return the decoded data.
size, if given, is passed as size argument to the stream’s
read()
method.If keepends is false line-endings will be stripped from the lines
returned.
-
readlines
([sizehint[, keepends]])¶ -
Read all lines available on the input stream and return them as a list of
lines.Line-endings are implemented using the codec’s decoder method and are
included in the list entries if keepends is true.sizehint, if given, is passed as the size argument to the stream’s
read()
method.
-
reset
()¶ -
Resets the codec buffers used for keeping state.
Note that no stream repositioning should take place. This method is
primarily intended to be able to recover from decoding errors.
-
In addition to the above methods, the StreamReader
must also inherit
all other methods and attributes from the underlying stream.
7.2.1.4.3. StreamReaderWriter Objects¶
The StreamReaderWriter
is a convenience class that allows wrapping
streams which work in both read and write modes.
The design is such that one can use the factory functions returned by the
lookup()
function to construct the instance.
-
class
codecs.
StreamReaderWriter
(stream, Reader, Writer, errors)¶ -
Creates a
StreamReaderWriter
instance. stream must be a file-like
object. Reader and Writer must be factory functions or classes providing the
StreamReader
andStreamWriter
interface resp. Error handling
is done in the same way as defined for the stream readers and writers.
StreamReaderWriter
instances define the combined interfaces of
StreamReader
and StreamWriter
classes. They inherit all other
methods and attributes from the underlying stream.
7.2.1.4.4. StreamRecoder Objects¶
The StreamRecoder
translates data from one encoding to another,
which is sometimes useful when dealing with different encoding environments.
The design is such that one can use the factory functions returned by the
lookup()
function to construct the instance.
-
class
codecs.
StreamRecoder
(stream, encode, decode, Reader, Writer, errors)¶ -
Creates a
StreamRecoder
instance which implements a two-way conversion:
encode and decode work on the frontend — the data visible to
code callingread()
andwrite()
, while Reader and Writer
work on the backend — the data in stream.You can use these objects to do transparent transcodings from e.g. Latin-1
to UTF-8 and back.The stream argument must be a file-like object.
The encode and decode arguments must
adhere to theCodec
interface. Reader and
Writer must be factory functions or classes providing objects of the
StreamReader
andStreamWriter
interface respectively.Error handling is done in the same way as defined for the stream readers and
writers.
StreamRecoder
instances define the combined interfaces of
StreamReader
and StreamWriter
classes. They inherit all other
methods and attributes from the underlying stream.
7.2.2. Encodings and Unicode¶
Strings are stored internally as sequences of code points in
range 0x0
–0x10FFFF
. (See PEP 393 for
more details about the implementation.)
Once a string object is used outside of CPU and memory, endianness
and how these arrays are stored as bytes become an issue. As with other
codecs, serialising a string into a sequence of bytes is known as encoding,
and recreating the string from the sequence of bytes is known as decoding.
There are a variety of different text serialisation codecs, which are
collectivity referred to as text encodings.
The simplest text encoding (called 'latin-1'
or 'iso-8859-1'
) maps
the code points 0–255 to the bytes 0x0
–0xff
, which means that a string
object that contains code points above U+00FF
can’t be encoded with this
codec. Doing so will raise a UnicodeEncodeError
that looks
like the following (although the details of the error message may differ):
UnicodeEncodeError: 'latin-1' codec can't encode character 'u1234' in
.
position 3: ordinal not in range(256)
There’s another group of encodings (the so called charmap encodings) that choose
a different subset of all Unicode code points and how these code points are
mapped to the bytes 0x0
–0xff
. To see how this is done simply open
e.g. encodings/cp1252.py
(which is an encoding that is used primarily on
Windows). There’s a string constant with 256 characters that shows you which
character is mapped to which byte value.
All of these encodings can only encode 256 of the 1114112 code points
defined in Unicode. A simple and straightforward way that can store each Unicode
code point, is to store each code point as four consecutive bytes. There are two
possibilities: store the bytes in big endian or in little endian order. These
two encodings are called UTF-32-BE
and UTF-32-LE
respectively. Their
disadvantage is that if e.g. you use UTF-32-BE
on a little endian machine you
will always have to swap bytes on encoding and decoding. UTF-32
avoids this
problem: bytes will always be in natural endianness. When these bytes are read
by a CPU with a different endianness, then bytes have to be swapped though. To
be able to detect the endianness of a UTF-16
or UTF-32
byte sequence,
there’s the so called BOM (“Byte Order Mark”). This is the Unicode character
U+FEFF
. This character can be prepended to every UTF-16
or UTF-32
byte sequence. The byte swapped version of this character (0xFFFE
) is an
illegal character that may not appear in a Unicode text. So when the
first character in an UTF-16
or UTF-32
byte sequence
appears to be a U+FFFE
the bytes have to be swapped on decoding.
Unfortunately the character U+FEFF
had a second purpose as
a ZERO WIDTH NO-BREAK SPACE
: a character that has no width and doesn’t allow
a word to be split. It can e.g. be used to give hints to a ligature algorithm.
With Unicode 4.0 using U+FEFF
as a ZERO WIDTH NO-BREAK SPACE
has been
deprecated (with U+2060
(WORD JOINER
) assuming this role). Nevertheless
Unicode software still must be able to handle U+FEFF
in both roles: as a BOM
it’s a device to determine the storage layout of the encoded bytes, and vanishes
once the byte sequence has been decoded into a string; as a ZERO WIDTH
it’s a normal character that will be decoded like any other.
NO-BREAK SPACE
There’s another encoding that is able to encoding the full range of Unicode
characters: UTF-8. UTF-8 is an 8-bit encoding, which means there are no issues
with byte order in UTF-8. Each byte in a UTF-8 byte sequence consists of two
parts: marker bits (the most significant bits) and payload bits. The marker bits
are a sequence of zero to four 1
bits followed by a 0
bit. Unicode characters are
encoded like this (with x being payload bits, which when concatenated give the
Unicode character):
Range | Encoding |
---|---|
U-00000000 … U-0000007F |
0xxxxxxx |
U-00000080 … U-000007FF |
110xxxxx 10xxxxxx |
U-00000800 … U-0000FFFF |
1110xxxx 10xxxxxx 10xxxxxx |
U-00010000 … U-0010FFFF |
11110xxx 10xxxxxx 10xxxxxx 10xxxxxx |
The least significant bit of the Unicode character is the rightmost x bit.
As UTF-8 is an 8-bit encoding no BOM is required and any U+FEFF
character in
the decoded string (even if it’s the first character) is treated as a ZERO
.
WIDTH NO-BREAK SPACE
Without external information it’s impossible to reliably determine which
encoding was used for encoding a string. Each charmap encoding can
decode any random byte sequence. However that’s not possible with UTF-8, as
UTF-8 byte sequences have a structure that doesn’t allow arbitrary byte
sequences. To increase the reliability with which a UTF-8 encoding can be
detected, Microsoft invented a variant of UTF-8 (that Python 2.5 calls
"utf-8-sig"
) for its Notepad program: Before any of the Unicode characters
is written to the file, a UTF-8 encoded BOM (which looks like this as a byte
sequence: 0xef
, 0xbb
, 0xbf
) is written. As it’s rather improbable
that any charmap encoded file starts with these byte values (which would e.g.
map to
LATIN SMALL LETTER I WITH DIAERESIS
RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
INVERTED QUESTION MARK
in iso-8859-1), this increases the probability that a utf-8-sig
encoding can be
correctly guessed from the byte sequence. So here the BOM is not used to be able
to determine the byte order used for generating the byte sequence, but as a
signature that helps in guessing the encoding. On encoding the utf-8-sig codec
will write 0xef
, 0xbb
, 0xbf
as the first three bytes to the file. On
decoding utf-8-sig
will skip those three bytes if they appear as the first
three bytes in the file. In UTF-8, the use of the BOM is discouraged and
should generally be avoided.
7.2.3. Standard Encodings¶
Python comes with a number of codecs built-in, either implemented as C functions
or with dictionaries as mapping tables. The following table lists the codecs by
name, together with a few common aliases, and the languages for which the
encoding is likely used. Neither the list of aliases nor the list of languages
is meant to be exhaustive. Notice that spelling alternatives that only differ in
case or use a hyphen instead of an underscore are also valid aliases; therefore,
e.g. 'utf-8'
is a valid alias for the 'utf_8'
codec.
CPython implementation detail: Some common encodings can bypass the codecs lookup machinery to
improve performance. These optimization opportunities are only
recognized by CPython for a limited set of aliases: utf-8, utf8,
latin-1, latin1, iso-8859-1, mbcs (Windows only), ascii, utf-16,
and utf-32. Using alternative spellings for these encodings may
result in slower execution.
Many of the character sets support the same languages. They vary in individual
characters (e.g. whether the EURO SIGN is supported or not), and in the
assignment of characters to code positions. For the European languages in
particular, the following variants typically exist:
- an ISO 8859 codeset
- a Microsoft Windows code page, which is typically derived from an 8859 codeset,
but replaces control characters with additional graphic characters - an IBM EBCDIC code page
- an IBM PC code page, which is ASCII compatible
Codec | Aliases | Languages |
---|---|---|
ascii | 646, us-ascii | English |
big5 | big5-tw, csbig5 | Traditional Chinese |
big5hkscs | big5-hkscs, hkscs | Traditional Chinese |
cp037 | IBM037, IBM039 | English |
cp273 | 273, IBM273, csIBM273 |
German New in version 3.4. |
cp424 | EBCDIC-CP-HE, IBM424 | Hebrew |
cp437 | 437, IBM437 | English |
cp500 | EBCDIC-CP-BE, EBCDIC-CP-CH, IBM500 |
Western Europe |
cp720 | Arabic | |
cp737 | Greek | |
cp775 | IBM775 | Baltic languages |
cp850 | 850, IBM850 | Western Europe |
cp852 | 852, IBM852 | Central and Eastern Europe |
cp855 | 855, IBM855 | Bulgarian, Byelorussian, Macedonian, Russian, Serbian |
cp856 | Hebrew | |
cp857 | 857, IBM857 | Turkish |
cp858 | 858, IBM858 | Western Europe |
cp860 | 860, IBM860 | Portuguese |
cp861 | 861, CP-IS, IBM861 | Icelandic |
cp862 | 862, IBM862 | Hebrew |
cp863 | 863, IBM863 | Canadian |
cp864 | IBM864 | Arabic |
cp865 | 865, IBM865 | Danish, Norwegian |
cp866 | 866, IBM866 | Russian |
cp869 | 869, CP-GR, IBM869 | Greek |
cp874 | Thai | |
cp875 | Greek | |
cp932 | 932, ms932, mskanji, ms-kanji | Japanese |
cp949 | 949, ms949, uhc | Korean |
cp950 | 950, ms950 | Traditional Chinese |
cp1006 | Urdu | |
cp1026 | ibm1026 | Turkish |
cp1125 | 1125, ibm1125, cp866u, ruscii |
Ukrainian New in version 3.4. |
cp1140 | ibm1140 | Western Europe |
cp1250 | windows-1250 | Central and Eastern Europe |
cp1251 | windows-1251 | Bulgarian, Byelorussian, Macedonian, Russian, Serbian |
cp1252 | windows-1252 | Western Europe |
cp1253 | windows-1253 | Greek |
cp1254 | windows-1254 | Turkish |
cp1255 | windows-1255 | Hebrew |
cp1256 | windows-1256 | Arabic |
cp1257 | windows-1257 | Baltic languages |
cp1258 | windows-1258 | Vietnamese |
cp65001 |
Windows only: Windows UTF-8 New in version 3.3. |
|
euc_jp | eucjp, ujis, u-jis | Japanese |
euc_jis_2004 | jisx0213, eucjis2004 | Japanese |
euc_jisx0213 | eucjisx0213 | Japanese |
euc_kr | euckr, korean, ksc5601, ks_c-5601, ks_c-5601-1987, ksx1001, ks_x-1001 |
Korean |
gb2312 | chinese, csiso58gb231280, euc- cn, euccn, eucgb2312-cn, gb2312-1980, gb2312-80, iso- ir-58 |
Simplified Chinese |
gbk | 936, cp936, ms936 | Unified Chinese |
gb18030 | gb18030-2000 | Unified Chinese |
hz | hzgb, hz-gb, hz-gb-2312 | Simplified Chinese |
iso2022_jp | csiso2022jp, iso2022jp, iso-2022-jp |
Japanese |
iso2022_jp_1 | iso2022jp-1, iso-2022-jp-1 | Japanese |
iso2022_jp_2 | iso2022jp-2, iso-2022-jp-2 | Japanese, Korean, Simplified Chinese, Western Europe, Greek |
iso2022_jp_2004 | iso2022jp-2004, iso-2022-jp-2004 |
Japanese |
iso2022_jp_3 | iso2022jp-3, iso-2022-jp-3 | Japanese |
iso2022_jp_ext | iso2022jp-ext, iso-2022-jp-ext | Japanese |
iso2022_kr | csiso2022kr, iso2022kr, iso-2022-kr |
Korean |
latin_1 | iso-8859-1, iso8859-1, 8859, cp819, latin, latin1, L1 |
West Europe |
iso8859_2 | iso-8859-2, latin2, L2 | Central and Eastern Europe |
iso8859_3 | iso-8859-3, latin3, L3 | Esperanto, Maltese |
iso8859_4 | iso-8859-4, latin4, L4 | Baltic languages |
iso8859_5 | iso-8859-5, cyrillic | Bulgarian, Byelorussian, Macedonian, Russian, Serbian |
iso8859_6 | iso-8859-6, arabic | Arabic |
iso8859_7 | iso-8859-7, greek, greek8 | Greek |
iso8859_8 | iso-8859-8, hebrew | Hebrew |
iso8859_9 | iso-8859-9, latin5, L5 | Turkish |
iso8859_10 | iso-8859-10, latin6, L6 | Nordic languages |
iso8859_11 | iso-8859-11, thai | Thai languages |
iso8859_13 | iso-8859-13, latin7, L7 | Baltic languages |
iso8859_14 | iso-8859-14, latin8, L8 | Celtic languages |
iso8859_15 | iso-8859-15, latin9, L9 | Western Europe |
iso8859_16 | iso-8859-16, latin10, L10 | South-Eastern Europe |
johab | cp1361, ms1361 | Korean |
koi8_r | Russian | |
koi8_t |
Tajik New in version 3.5. |
|
koi8_u | Ukrainian | |
kz1048 | kz_1048, strk1048_2002, rk1048 |
Kazakh New in version 3.5. |
mac_cyrillic | maccyrillic | Bulgarian, Byelorussian, Macedonian, Russian, Serbian |
mac_greek | macgreek | Greek |
mac_iceland | maciceland | Icelandic |
mac_latin2 | maclatin2, maccentraleurope | Central and Eastern Europe |
mac_roman | macroman, macintosh | Western Europe |
mac_turkish | macturkish | Turkish |
ptcp154 | csptcp154, pt154, cp154, cyrillic-asian |
Kazakh |
shift_jis | csshiftjis, shiftjis, sjis, s_jis |
Japanese |
shift_jis_2004 | shiftjis2004, sjis_2004, sjis2004 |
Japanese |
shift_jisx0213 | shiftjisx0213, sjisx0213, s_jisx0213 |
Japanese |
utf_32 | U32, utf32 | all languages |
utf_32_be | UTF-32BE | all languages |
utf_32_le | UTF-32LE | all languages |
utf_16 | U16, utf16 | all languages |
utf_16_be | UTF-16BE | all languages |
utf_16_le | UTF-16LE | all languages |
utf_7 | U7, unicode-1-1-utf-7 | all languages |
utf_8 | U8, UTF, utf8 | all languages |
utf_8_sig | all languages |
Changed in version 3.4: The utf-16* and utf-32* encoders no longer allow surrogate code points
(U+D800
–U+DFFF
) to be encoded.
The utf-32* decoders no longer decode
byte sequences that correspond to surrogate code points.
7.2.4. Python Specific Encodings¶
A number of predefined codecs are specific to Python, so their codec names have
no meaning outside Python. These are listed in the tables below based on the
expected input and output types (note that while text encodings are the most
common use case for codecs, the underlying codec infrastructure supports
arbitrary data transforms rather than just text encodings). For asymmetric
codecs, the stated purpose describes the encoding direction.
7.2.4.1. Text Encodings¶
The following codecs provide str
to bytes
encoding and
bytes-like object to str
decoding, similar to the Unicode text
encodings.
Codec | Aliases | Purpose |
---|---|---|
idna | Implements RFC 3490, see also encodings.idna .Only errors='strict' is supported. |
|
mbcs | ansi, dbcs |
Windows only: Encode operand according to the ANSI codepage (CP_ACP) |
oem |
Windows only: Encode New in version 3.6. |
|
palmos | Encoding of PalmOS 3.5 | |
punycode | Implements RFC 3492. Stateful codecs are not supported. |
|
raw_unicode_escape | Latin-1 encoding withuXXXX andUXXXXXXXX for othercode points. Existing backslashes are not escaped in any way. It is used in the Python pickle protocol. |
|
undefined | Raise an exception for all conversions, even empty strings. The error handler is ignored. |
|
unicode_escape | Encoding suitable as the contents of a Unicode literal in ASCII-encoded Python source code, except that quotes are not escaped. Decodes from Latin-1 source code. Beware that Python source code actually uses UTF-8 by default. |
|
unicode_internal |
Return the internal Deprecated since version 3.3: This representation is |
7.2.4.3. Text Transforms¶
The following codec provides a text transform: a str
to str
mapping. It is not supported by str.encode()
(which only produces
bytes
output).
Codec | Aliases | Purpose |
---|---|---|
rot_13 | rot13 | Returns the Caesar-cypher encryption of the operand |
New in version 3.2: Restoration of the rot_13
text transform.
Changed in version 3.4: Restoration of the rot13
alias.
7.2.5. encodings.idna
— Internationalized Domain Names in Applications¶
This module implements RFC 3490 (Internationalized Domain Names in
Applications) and RFC 3492 (Nameprep: A Stringprep Profile for
Internationalized Domain Names (IDN)). It builds upon the punycode
encoding
and stringprep
.
These RFCs together define a protocol to support non-ASCII characters in domain
names. A domain name containing non-ASCII characters (such as
www.Alliancefrançaise.nu
) is converted into an ASCII-compatible encoding
(ACE, such as www.xn--alliancefranaise-npb.nu
). The ACE form of the domain
name is then used in all places where arbitrary characters are not allowed by
the protocol, such as DNS queries, HTTP fields, and so
on. This conversion is carried out in the application; if possible invisible to
the user: The application should transparently convert Unicode domain labels to
IDNA on the wire, and convert back ACE labels to Unicode before presenting them
to the user.
Python supports this conversion in several ways: the idna
codec performs
conversion between Unicode and ACE, separating an input string into labels
based on the separator characters defined in section 3.1 (1) of RFC 3490
and converting each label to ACE as required, and conversely separating an input
byte string into labels based on the .
separator and converting any ACE
labels found into unicode. Furthermore, the socket
module
transparently converts Unicode host names to ACE, so that applications need not
be concerned about converting host names themselves when they pass them to the
socket module. On top of that, modules that have host names as function
parameters, such as http.client
and ftplib
, accept Unicode host
names (http.client
then also transparently sends an IDNA hostname in the
field if it sends that field at all).
When receiving host names from the wire (such as in reverse name lookup), no
automatic conversion to Unicode is performed: Applications wishing to present
such host names to the user should decode them to Unicode.
The module encodings.idna
also implements the nameprep procedure, which
performs certain normalizations on host names, to achieve case-insensitivity of
international domain names, and to unify similar characters. The nameprep
functions can be used directly if desired.
-
encodings.idna.
nameprep
(label)¶ -
Return the nameprepped version of label. The implementation currently assumes
query strings, soAllowUnassigned
is true.
-
encodings.idna.
ToASCII
(label)¶ -
Convert a label to ASCII, as specified in RFC 3490.
UseSTD3ASCIIRules
is
assumed to be false.
-
encodings.idna.
ToUnicode
(label)¶ -
Convert a label to Unicode, as specified in RFC 3490.
7.2.6. encodings.mbcs
— Windows ANSI codepage¶
Encode operand according to the ANSI codepage (CP_ACP).
Availability: Windows only.
Changed in version 3.3: Support any error handler.
Changed in version 3.2: Before 3.2, the errors argument was ignored; 'replace'
was always used
to encode, and 'ignore'
to decode.
7.2.7. encodings.utf_8_sig
— UTF-8 codec with BOM signature¶
This module implements a variant of the UTF-8 codec: On encoding a UTF-8 encoded
BOM will be prepended to the UTF-8 encoded bytes. For the stateful encoder this
is only done once (on the first write to the byte stream). For decoding an
optional UTF-8 encoded BOM at the start of the data will be skipped.
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||
1 |
||||
08.10.2013, 01:17. Показов 54916. Ответов 17 Метки кракозябры (Все метки)
Написал такой код:
Выводит — мама мыла раму
__________________
0 |
alex925 2738 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,832 |
||||
08.10.2013, 01:21 |
2 |
|||
Попробуй так:
0 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||||||
08.10.2013, 01:28 [ТС] |
3 |
|||||||
Попробуй так:
0 |
alex925 2738 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,832 |
||||
08.10.2013, 01:32 |
4 |
|||
0 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||
08.10.2013, 01:35 [ТС] |
5 |
|||
мама мыла раму
0 |
2738 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,832 |
|
08.10.2013, 01:36 |
6 |
У меня все нормально. Ты с консолью виндовой работаешь? Я просто пробовал в IDLE. Если в консоли, то тебе нужно преобразовать в данные в кодировку cp688.
0 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||||||
08.10.2013, 01:40 [ТС] |
7 |
|||||||
С консолью Pycharm. Ну он наверное виндовую использует. Добавлено через 3 минуты
0 |
JohnHomo 8 / 8 / 0 Регистрация: 26.09.2013 Сообщений: 31 |
||||||||||||||||
08.10.2013, 05:12 |
8 |
|||||||||||||||
С консолью Pycharm. Ну он наверное виндовую использует. Добавлено через 3 минуты
Кодировка виндовой консоли не cp688 , а cp866.
или так:
1 |
2738 / 2341 / 620 Регистрация: 19.03.2012 Сообщений: 8,832 |
|
08.10.2013, 07:50 |
9 |
Кодировка виндовой консоли не cp688 , а cp866. спасибо, что поправил Добавлено через 3 минуты
1 |
dondublon 4606 / 2027 / 359 Регистрация: 17.03.2012 Сообщений: 10,081 Записей в блоге: 6 |
||||
08.10.2013, 13:31 |
10 |
|||
должно сработать.
1 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||
08.10.2013, 15:33 [ТС] |
11 |
|||
Спасибо всем, кто пытался помочь)
по непонятным причинам сработало
0 |
840 / 478 / 58 Регистрация: 18.09.2012 Сообщений: 1,688 |
|
08.10.2013, 17:00 |
12 |
Нашёл вот такую штучку, может поможет) Миниатюры
3 |
840 / 478 / 58 Регистрация: 18.09.2012 Сообщений: 1,688 |
|
08.10.2013, 17:01 |
13 |
Тут проще понять какая ошибка с кодировкой, чем методом перебора)
0 |
accept 4864 / 3286 / 468 Регистрация: 10.12.2008 Сообщений: 10,570 |
||||||||||||||||
08.10.2013, 21:35 |
14 |
|||||||||||||||
кодировка — это именованный аргумент
всё правильно выдаёт, там ожидается тип буферизации
0 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||||||
08.10.2013, 22:09 [ТС] |
15 |
|||||||
0 |
4864 / 3286 / 468 Регистрация: 10.12.2008 Сообщений: 10,570 |
|
08.10.2013, 23:49 |
16 |
Что я делаю не так? Питон 3 версии. значит, не третьей версии он у тебя, а второй
0 |
DarthLenin 0 / 0 / 0 Регистрация: 22.09.2013 Сообщений: 24 |
||||
09.10.2013, 00:03 [ТС] |
17 |
|||
значит, не третьей версии он у тебя, а второй Ок, я случайно запустил под 2.7 интерпретатором
Вот что выдает 3
0 |
4864 / 3286 / 468 Регистрация: 10.12.2008 Сообщений: 10,570 |
|
09.10.2013, 00:07 |
18 |
значит, файл в другой кодировке (в нём есть символы, которые допустимы в другой кодировке, но не допустимы в cp1251)
0 |
Содержание
- Проблемы с кодировкой в Python
- Использование
- Строки в скрипте
- Загрузка и сохранение файла
- Текст в скрипте
- Авто-преобразование кодировки
- Результат
- Пример авто-преобразования кодировок в сравнении
- Результат
- Вывод списков
- Результат:
- Установка внешней кодировки при запуске
- Python open file encoding windows 1251
- Открываем, а затем читаем или записываем
- Чтение файла с разной кодировкой
- Добавление в конец и запрет открытия файлов
- Временные файлы
- Именованные временные файлы
- Временные папки
- Работаем с текстами на Python: кодировки, нормализация, чистка
- Зачем эта статья?
- Откуда взялась статья?
- Проблема чтения файлов
- Кодировка
- Ошибки, связанные с кодировками
- Cворачивание регистра
- Нормализация
- encoding windows 1251 python
- 2 ответа
- 3 Answers 3
- Использование
- Строки в скрипте
- Загрузка и сохранение файла
- Текст в скрипте
- Авто-преобразование кодировки
- Результат
- Пример авто-преобразования кодировок в сравнении
- Результат
- Вывод списков
- Результат:
- Установка внешней кодировки при запуске
- Исчерпывающее руководство по Юникоду и кодировке символов в Python
- Авторизуйтесь
- Исчерпывающее руководство по Юникоду и кодировке символов в Python
- Изучив эту статью, вы:
- Что такое кодировка символов?
- Модуль string
- Что такое биты
- Нам нужно больше бит
- Изучаем основы: другие системы счисления
- Введение в Юникод
- Юникод и UTF-8
- Кодирование и декодирование в Python 3
- Python 3: всё на Юникоде
- Один байт, два байта, три байта, четыре…
- Особенности UTF-16 и UTF-32
- Python и встроенные функции
Проблемы с кодировкой в Python
В python есть 2 объекта работающими с текстом: unicode и str, объект unicode хранит символы в формате (кодировке) unicode, объект str является набором байт/символов в которых python хранит остальные кодировки (utf8, cp1251, cp866, koi8-r и др).
Внешняя кодировка (объект str) предназначена для хранения и передачи текстовой информации вне скрипта, например для сохранения в файл или передачи по сети. Поэтому в данной статье я её назвал внешней. Самой используемой кодировкой в мире является utf8 и число приложений переходящих на эту кодировку растет каждый день, таким образом превращаясь в «стандарт».
Эта кодировка хороша тем что для хранения текста она занимает оптимальное кол-во памяти и с помощью её можно закодировать почти все языки мира ( в отличие от cp1251 и подобных однобайтовых кодировок). Поэтому рекомендуется везде использовать utf8, и при написании скриптов.
Использование
Скрипт питона, в самом начале скрипта указываем кодировку файла и сохраняем в ней файл
для того что-бы интерпретатор python понял в какой кодировке файл
Строки в скрипте
Строки в скрипте хранятся байтами, от кавычки до кавычки:
Если перед строкой добавить символ u, то при запуске скрипта, эта байтовая строка будет декодирована в unicode из кодировки указанной в начале :
и если кодировка содержимого в файле отличается от указанной, то в строке могут быть «битые символы»
Загрузка и сохранение файла
Текст в скрипте
Процедуре print текст желательно передавать в рабочей кодировке либо кодировать в кодировку ОС.
Результат скрипта при запуске из консоли windows XP:
b = Текст в unicode
В последней строке print преобразовал unicode в cp866 автоматический, см. следующий пункт
Авто-преобразование кодировки
В некоторых случаях для упрощения разработки python делает преобразование кодировки, пример с методом print можно посмотреть в предыдущем пункте.
Результат
b = Текст в unicode
c = Текст в utf8Текст в unicode
Как видим результирующая строка «c» в unicode. Если бы кодировки строк совпадали то авто-перекодирования не произошло бы и результирующая строка содержала кодировку слагаемых строк.
Авто-перекодирование обычно срабатывает когда происходит взаимодействие разных кодировок.
Пример авто-преобразования кодировок в сравнении
Результат
1. utf8 and unicode true
2. utf8 and cp1251 false
print ‘3. cp1251 and unicode’, ‘true’ if u’Слово’.encode(‘cp1251′) == u’Слово’ else ‘false’
3. cp1251 and unicode false
В сравнении 1, кодировка utf8 преобразовалась в unicode и сравнение произошло корректно.
Вывод списков
Результат:
1 [‘xd0xa2xd0xb5xd1x81xd1x82’, ‘xd1x81xd0xbfxd0xb8xd1x81xd0xbaxd0xb0’]
2 [‘xd0xa2xd0xb5xd1x81xd1x82’, ‘xd1x81xd0xbfxd0xb8xd1x81xd0xbaxd0xb0’]
Установка внешней кодировки при запуске
В обучении ребенка важно правильное толкование окружающего его мира. Существует масса полезных журналов которые начнут экологическое воспитание дошкольников правильным путем. Развивать интерес к окружающему миру очень трудный но интересный процесс, уделите этому особое внимание.
Источник
Python open file encoding windows 1251
На практике в реальных проектах Data Science часто приходится сталкиваться с чтением датасетов, а также записывать добытую в ходе вычислений информацию в файлы. Сегодня мы расскажем о работе с файлами в Python: чтение и запись, проблема с кодировками, добавление значений в конец файла, временные папки и файлы.
Открываем, а затем читаем или записываем
Предположим, у нас имеется файл, который нужно прочитать в Python. Для этого можно воспользоваться функцией open внутри контекстного менеджера:
Таким же образом можно записать информацию в файл, указав w в качестве аргумента:
Во-вторых, мы использовали функцию open в контекстном менеджере. Можно обойтись и без него, но тогда после чтения или записи следует закрыть файл.
На открытие файла Python выделяет память, поэтому, чтобы избежать ее утечки, рекомендуется закрывать файлы.
Чтение файла с разной кодировкой
На многих операционных системах Python в качестве стандарта кодирования использует UTF-8, который также поддерживает кириллицу. Тем не менее, часто можно столкнуться с проблемами неправильной кодировки и получить распространенную ошибку вроде этой:
В примере указана кодировка ASCII, но файл закодирован в другом формате, поэтому и возникает такая ошибка. Решить ее можно тремя способами:
Добавление в конец и запрет открытия файлов
Если файла не существует, то при a и при w он будет создан. Но чтобы не трогать существующие файлы, а создать новый, передается параметр x :
Временные файлы
Иногда бывает, что требуется создать файл или папку внутри Python-программы, а после ее закрытия их нужно удалить. Тогда пригодится стандартный модуль tempfile. Например, класс TemporaryFile создаст временный файл, который удалится после закрытия. Ниже пример в Python.
Третье, файл TemporaryFile невидим для файловой системы, он используется только внутри Python, поэтому извне будет трудно его найти.
Именованные временные файлы
А вот объекты класса NamedTemporaryFile будут видны файловой системе, и найти месторасположение можно с помощью атрибута name :
Временные папки
Кроме временных файлов можно создавать временные папки. Для этого используется класс TemporaryDirectory :
В следующей статье поговорим о взаимодействии файловой системы и Python. А получить практические навыки работы с файлами на реальных проектах Data Science вы сможете на наших курсах по Python в лицензированном учебном центре обучения и повышения квалификации IT-специалистов в Москве.
Источник
Работаем с текстами на Python: кодировки, нормализация, чистка
Зачем эта статья?
Об обработке текстов на естественном языке сейчас знают все. Все хоть раз пробовали задавать вопрос Сири или Алисе, пользовались Grammarly (это не реклама), пробовали генераторы стихов, текстов. или просто вводили запрос в Google. Да, вот так просто. На самом деле Google понимает, что вы от него хотите, благодаря штукам, которые умеют обрабатывать и анализировать естественную речь в вашем запросе.
При анализе текста мы можем столкнуться с ситуациями, когда текст содержит специфические символы, которые необходимо проанализировать наравне с «простым текстом» (взять даже наши горячо любимые вставки на французском из «Война и мир») или формулы, например. В таком случае обработка текста может усложниться.
Вы можете заметить, что если ввести в поисковую строку запрос с символами с ударением (так называемый модифицирующий акут), к примеру «ó», поисковая система может показать результаты, содержащие слова из вашего запроса, символы с ударением уже выглядят как обычные символы.
Обратите внимание на следующий запрос:
Запрос содержит символ с модифицирующим акутом, однако во втором результате мы можем заметить, что выделено найденное слово из запроса, только вот оно не содержит вышеупомянутый символ, просто букву «о».
Конечно, уже есть много готовых инструментов, которые довольно неплохо справляются с обработкой текстов и могут делать разные крутые вещи, но я не об этом хочу вам поведать. Я не буду рассказывать про nltk, стемминг, лемматизацию и т.п. Я хочу опуститься на несколько ступенек ниже и обсудить некоторые тонкости кодировок, байтов, их обработки.
Откуда взялась статья?
Одним из важных составляющих в области ИИ является обработка текстов на естественном языке. В процессе изучения данной тематики я начал задавать себе вопросы, которые в конечном итоге привели меня к изучению кодировок, представлению текстов в памяти, как они преобразуются, приводятся к нормальной форме. Я плохо понимал эту тему в начале, потребовалось немало времени и мозгового ресурса, чтобы понять, принять и запомнить некоторые вещи. Написанием данной статьи я хочу облегчить жизнь людям, которые столкнутся с необходимостью чтения и обработки текстов на Python и самому закрепить изученное. А некоторыми полезными поинтами своего изучения я постараюсь поделиться в данной статье.
Важная ремарка: я не являюсь специалистом в области обработки текстов. Изложенный материал является результатом исключительно любительского изучения.
Проблема чтения файлов
Допустим, у нас есть файл с текстом. Нам нужно этот текст прочитать. Казалось бы, пиши себе такой вот скрипт для чтения из файла да и радуйся:
В файле содержится вот такое вот изречение:
что переводится с испанского как питон. Однако консоль OC Windows 10 покажет нам немного другой результат:
Сейчас мы разберёмся, что именно пошло не так и по какой причине.
Кодировка
Думаю, это не будет сюрпризом, если я скажу, что любой символ, который заносится в память компьютера, хранится в виде числа, а не в виде литерала. Это число определяется как идентификатор или кодовая позиция символа. Кодировка определяет, какое именно число будет ассоциировано с символом.
Предположим, у нас есть некоторый файл с неизвестным содержимым, и нам нужно его прочитать, однако мы не знаем, какая у файла кодировка. Попробуем декодировать содержимое файла.
Посмотрим на результат:
Важный поинт: при записи и чтении из файлов следует указывать конкретную кодировку, это позволит избежать путаницы в дальнейшем.
Ошибки, связанные с кодировками
При возникновении ошибки, связанной с кодировками, интерпретатор выдаст одно из следующих исключений:
Попытка выполнения вот такого кода (в файле всё ещё содержится испанский питон):
даст нам следующий результат:
Обозначение
Суть
Значение по умолчанию. Несоотвествующие кодировке символы возбуждают исключения UnicodeError и наследуемые от него.
Несоответсвующие символы пропускаются без возбуждения исключений.
Только для метода encode :
Несоответствующие символы заменяются на соответсвующие значения XML.
Несоответствующие символы заменяются на определённые последовательности с обратным слэшем.
Несоответствующие символы заменяются на имена этих символов, которые берутся из базы данных Unicode.
Приведём пример использования таких обработчиков:
Важный поинт: если в текстах могут встретиться неожиданные для кодировки символы, во избежание возбуждения исключений можно использовать обработчики.
Cворачивание регистра
И по классике приведём пример:
В результате применённый метод не только привёл весь текст к нижнему регистру, но и преобразовал специфический немецкий символ.
Нормализация
Чтобы обозначить важность нормализации, приведём простой пример:
Внешне два этих символа выглядят абсолютно одинаково. Однако если мы попытаемся вывести имена этих символов, как их видит интерпретатор Python’a, результат нас порядком удивит.
В Python есть отличный встроенный модуль, который содержит данные о символах Unicode, их имена, являются ли они цифрамии и т.п. (методы по типу str.isdigit() берут информацию из этих данных). Воспользуемся данным модулем, чтобы вывести имена символов, исходя из информации, которая содержится в базе данных Unicode.
Результат выполнения данного кода:
Итак, интерпретатор Python’a видит эти символы как два разных, но в стандарте Unicode они имеют одинаковое отображение.Такие символы называют каноническими эквивалентами. Приложения будут считать два этих символа одинаковыми, но не интерпретатор.
Посмотрим на ещё один пример:
Данные символы также будут являться каноническими эквивалентами. Из примера мы видим, что символ «é» в стандарте Unicodeможет быть представлен двумя способами, которые к тому же имеют разную длину. Символ «é» может быть представлен одним или двумя байтами.
Источник
encoding windows 1251 python
Мне нужно получить источник страницы (html) и преобразовать его в uft8, потому что я хочу найти текст на этой странице (например, если «my_same_text» в page_source: then. ). Эта страница содержит русский текст (кириллические символы), и этот тег
Я использую колбу и запрашиваю python lib. я отправляю запрос source = запросы.get(‘url/’)
и я не могу найти свой текст, это связано с кодировкой, как я могу преобразовать текст в utf8? Я пытаюсь использовать.encode().decode(), но это не помогло.
python flask utf-8 python-requests encode
2 ответа
4 Решение Igor Hatarist [2015-02-06 15:25:00]
Позвольте создать страницу с кодировкой windows-1251 указанную в meta и некоторый русский абсурдный текст. Я сохранил его в Sublime Text как файл windows-1251, конечно.
Вы можете использовать небольшой трюк в библиотеке requests :
Если вы измените кодировку, Requests будет использовать новое значение r.encoding всякий раз, когда вы вызываете r.text.
Так оно и происходит:
Если это не сработает для вас, есть немного уродливый подход.
Вы должны взглянуть на то, какую кодировку посылает вам веб-сервер.
Поэтому мы должны соответствующим образом перекодировать его.
I’m trying to convert file content from Windows-1251 (Cyrillic) to Unicode with Python. I found this function, but it doesn’t work.
3 Answers 3
Is this what you intend to do?
This is just a guess, since you didn’t specify what you mean by «doesn’t work».
If the file is being generated properly but appears to contain garbage characters, likely the application you’re viewing it with does not recognize that it contains UTF-8. You need to add a BOM to the beginning of the file — the 3 bytes 0xEF,0xBB,0xBF (unencoded).
If you use the codecs module to open the file, it will do the conversion to Unicode for you when you read from the file. E.g.:
This only makes sense if you’re working with the file’s data in Python. If you’re trying to convert a file from one encoding to another on the filesystem (which is what the script you posted tries to do), you’ll have to specify an actual encoding, since you can’t write a file in «Unicode».
В python есть 2 объекта работающими с текстом: unicode и str, объект unicode хранит символы в формате (кодировке) unicode, объект str является набором байт/символов в которых python хранит остальные кодировки (utf8, cp1251, cp866, koi8-r и др).
Кодировку unicode можно считать рабочей кодировкой питона т.к. она предназначена для её использования в самом скрипте — для разных операций над строками.
Внешняя кодировка (объект str) предназначена для хранения и передачи текстовой информации вне скрипта, например для сохранения в файл или передачи по сети. Поэтому в данной статье я её назвал внешней. Самой используемой кодировкой в мире является utf8 и число приложений переходящих на эту кодировку растет каждый день, таким образом превращаясь в «стандарт».
Эта кодировка хороша тем что для хранения текста она занимает оптимальное кол-во памяти и с помощью её можно закодировать почти все языки мира ( в отличие от cp1251 и подобных однобайтовых кодировок). Поэтому рекомендуется везде использовать utf8, и при написании скриптов.
Использование
Скрипт питона, в самом начале скрипта указываем кодировку файла и сохраняем в ней файл
для того что-бы интерпретатор python понял в какой кодировке файл
Строки в скрипте
Строки в скрипте хранятся байтами, от кавычки до кавычки:
Если перед строкой добавить символ u, то при запуске скрипта, эта байтовая строка будет декодирована в unicode из кодировки указанной в начале :
и если кодировка содержимого в файле отличается от указанной, то в строке могут быть «битые символы»
Загрузка и сохранение файла
Текст в скрипте
Процедуре print текст желательно передавать в рабочей кодировке либо кодировать в кодировку ОС.
Результат скрипта при запуске из консоли windows XP:
b = Текст в unicode
В последней строке print преобразовал unicode в cp866 автоматический, см. следующий пункт
Авто-преобразование кодировки
В некоторых случаях для упрощения разработки python делает преобразование кодировки, пример с методом print можно посмотреть в предыдущем пункте.
В примере ниже, python сам переводит utf8 в unicode — приводит к одной кодировке для того что-бы сложить строки.
Результат
b = Текст в unicode
c = Текст в utf8Текст в unicode
Как видим результирующая строка «c» в unicode. Если бы кодировки строк совпадали то авто-перекодирования не произошло бы и результирующая строка содержала кодировку слагаемых строк.
Авто-перекодирование обычно срабатывает когда происходит взаимодействие разных кодировок.
Пример авто-преобразования кодировок в сравнении
Результат
1. utf8 and unicode true
2. utf8 and cp1251 false
script.py:10: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode — interpreting them as being unequal
print ‘3. cp1251 and unicode’, ‘true’ if u’Слово’.encode(‘cp1251′) == u’Слово’ else ‘false’
3. cp1251 and unicode false
В сравнении 1, кодировка utf8 преобразовалась в unicode и сравнение произошло корректно.
В сравнении 2, сравниваются кодировки одного вида — обе внешние, т.к. кодированы они в разных кодировках условие выдало что они не равны.
В сравнении 3, выпало предупреждение из за того что выполняется сравнение кодировок разного вида — рабочая и внешняя, а авто-декодирование не произошло т.к. стандартная внешняя кодировка = utf8, и декодировать строку в кодировке cp1251 методом utf8 питон не смог.
Вывод списков
Результат:
1 [‘xd0xa2xd0xb5xd1x81xd1x82’, ‘xd1x81xd0xbfxd0xb8xd1x81xd0xbaxd0xb0’]
2 [‘xd0xa2xd0xb5xd1x81xd1x82’, ‘xd1x81xd0xbfxd0xb8xd1x81xd0xbaxd0xb0’]
При выводе списка, происходит вызов [ ]() который возвращает внутреннее представление этого спиcка — print 1 и 2 являются аналогичными. Для корректного вывода списка, его нужно преобразовать в строку — print 3.
Установка внешней кодировки при запуске
В обучении ребенка важно правильное толкование окружающего его мира. Существует масса полезных журналов которые начнут экологическое воспитание дошкольников правильным путем. Развивать интерес к окружающему миру очень трудный но интересный процесс, уделите этому особое внимание.
Источник
Исчерпывающее руководство по Юникоду и кодировке символов в Python
Авторизуйтесь
Исчерпывающее руководство по Юникоду и кодировке символов в Python
Вводная часть статьи даст общее понимание работы с Юникодом, не привязанное к какому-то определённому языку, однако практические примеры будут приведены именно на Python, а их описание будет довольно лаконичным.
Изучив эту статью, вы:
Система нумерации и кодировка символов настолько тесно связаны, что их придётся раскрыть в одном руководстве, в противном случае материал будет неполным.
Прим. Статья ориентирована на Python 3, а все примеры кода созданы с помощью оболочки CPython 3.7.2. Большая часть более ранних версий Python 3 также будут корректно обрабатывать код. Если вы всё ещё используете Python 2 и различия в обработке текста и бинарных данных между 2 и 3 версиями языка вас отпугивают, это руководство может помочь вам преодолеть барьер.
Что такое кодировка символов?
Существуют десятки, если не сотни, кодировок символов. Понять эту концепцию легче всего, разобрав одну из самых простых, ASCII.
Она охватывает следующее:
Приведём формальное определение кодировки символов.
На самом высоком уровне — это способ перевода символов (таких как буквы, знаки пунктуации, служебные знаки, пробелы и контрольные символы) в целые числа и затем непосредственно в биты. Каждый символ может быть закодирован уникальным двоичным кодом. Если вы плохо знакомы с концепцией битов, не волнуйтесь, мы вскоре о ней поговорим.
Группы символов выделяют в отдельные категории. Каждому символу соответствует кодовая точка, которую можно рассматривать просто как целое число. В таблице ASCII символы сегментированы следующим образом:
Диапазон кодовых точек | Класс |
---|---|
от 0 до 31 | Контрольные и неотображаемые символы |
от 32 до 64 | Знаки пунктуации, символы, числа и пробел |
от 65 до 90 | Буквы английского алфавита в верхнем регистре |
от 91 до 96 | Дополнительные графемы, такие как [ и |
от 97 до 122 | Буквы английского алфавита в нижнем регистре |
от 123 до 126 | Дополнительные графемы, такие как < и | |
127 | Контрольный неотображаемый символ ( DEL ) |
Всего кодировка ASCII содержит 128 символов. В таблице ниже вы видите исчерпывающий набор знаков, которые позволяет отобразить эта кодировка. Если вы не видите какого-то символа, значит вы просто не сможете его вывести с помощью ASCII.
Кодовая точка | Символ (имя) | Кодовая точка | Символ (имя) |
---|---|---|---|
NUL (Null) | 64 | @ | |
1 | SOH (Start of Heading) | 65 | A |
2 | STX (Start of Text) | 66 | B |
3 | ETX (End of Text) | 67 | C |
4 | EOT (End of Transmission) | 68 | D |
5 | ENQ (Enquiry) | 69 | E |
6 | ACK (Acknowledgment) | 70 | F |
7 | BEL (Bell) | 71 | G |
8 | BS (Backspace) | 72 | H |
9 | HT (Horizontal Tab) | 73 | I |
10 | LF (Line Feed) | 74 | J |
11 | VT (Vertical Tab) | 75 | K |
12 | FF (Form Feed) | 76 | L |
13 | CR (Carriage Return) | 77 | M |
14 | SO (Shift Out) | 78 | N |
15 | SI (Shift In) | 79 | O |
16 | DLE (Data Link Escape) | 80 | P |
17 | DC1 (Device Control 1) | 81 | Q |
18 | DC2 (Device Control 2) | 82 | R |
19 | DC3 (Device Control 3) | 83 | S |
20 | DC4 (Device Control 4) | 84 | T |
21 | NAK (Negative Acknowledgment) | 85 | U |
22 | SYN (Synchronous Idle) | 86 | V |
23 | ETB (End of Transmission Block) | 87 | W |
24 | CAN (Cancel) | 88 | X |
25 | EM (End of Medium) | 89 | Y |
26 | SUB (Substitute) | 90 | Z |
27 | ESC (Escape) | 91 | [ |
28 | FS (File Separator) | 92 | |
29 | GS (Group Separator) | 93 | ] |
30 | RS (Record Separator) | 94 | ^ |
31 | US (Unit Separator) | 95 | _ |
32 | SP (Space) | 96 | ` |
33 | ! | 97 | a |
34 | « | 98 | b |
35 | # | 99 | c |
36 | $ | 100 | d |
37 | % | 101 | e |
38 | & | 102 | f |
39 | ‘ | 103 | g |
40 | ( | 104 | h |
41 | ) | 105 | i |
42 | * | 106 | j |
43 | + | 107 | k |
44 | , | 108 | l |
45 | — | 109 | m |
46 | . | 110 | n |
47 | / | 111 | o |
48 | 112 | p | |
49 | 1 | 113 | q |
50 | 2 | 114 | r |
51 | 3 | 115 | s |
52 | 4 | 116 | t |
53 | 5 | 117 | u |
54 | 6 | 118 | v |
55 | 7 | 119 | w |
56 | 8 | 120 | x |
57 | 9 | 121 | y |
58 | : | 122 | z |
59 | ; | 123 | < |
60 | 124 | | | |
61 | = | 125 | > |
62 | > | 126 | |
63 | ? | 127 | DEL (delete) |
Модуль string
Модуль string — простой и удобный инструмент, разграничивающий содержащиеся в ASCII символы по группам, разделяя их в строки-константы. Вот как выглядит основная часть модуля:
Мы можем использовать определённые в модуле константы для рутинных операций:
Что такое биты
Настало время вспомнить, что такое бит, базовая единица информации, которой оперируют вычислительные устройства.
Бит — это сигнал, который имеет два возможных состояния. Есть различные способы символического отображения этих состояний:
Таблица ASCII из предыдущего раздела использует то, что обычно назвали бы числами (от 0 до 127), однако для наших целей важно понимать, что это десятичные числа (с основанием 10).
Каждое из этих десятичных чисел можно выразить последовательностью бит (числом с основанием 2). Вот таблица соотношения двоичных и десятичных чисел:
Десятичное | Двоичное (кратко) | Двоичное (в байте) |
---|---|---|
00000000 | ||
1 | 1 | 00000001 |
2 | 10 | 00000010 |
3 | 11 | 00000011 |
4 | 100 | 00000100 |
5 | 101 | 00000101 |
6 | 110 | 00000110 |
7 | 111 | 00000111 |
8 | 1000 | 00001000 |
9 | 1001 | 00001001 |
10 | 1010 | 00001010 |
Обратите внимание, что при увеличении десятичного числа n для его отображения (а следовательно и для отображения символа, относящегося к этому числу) требуется всё больше значимых бит.
Вот удобный метод представить строки ASCII как последовательность бит. Каждый символ из строки ASCII переводится в последовательность из 8 нолей и единиц с пробелами между этими последовательностями:
Строковой литерал f-string f»» использует мини-язык форматирования Format Specification Mini-Language, а именно его возможность замещения полей при форматировании строк.
На самом деле этот метод можно использовать разве что для развлечения. Он выдаст ошибку для любого символа, не представленного в ASCII-таблице. Позже мы рассмотрим, как эта проблема решается в других кодировках.
Нам нужно больше бит
Исходя из определения бита, можно вывести следующую закономерность: при определённом количестве бит n с их помощью можно выразить 2 n разных значений.
Вот что это означает:
В качестве естественного вывода из приведённой выше формулы мы можем установить следующее: для того, чтобы вычислить количество бит, необходимых для выражения определённого числа разных значений, нам нужно найти n в уравнении 2 n =x, где переменная x известна.
Вот как можно это рассчитать:
Округление вверх в методе n_bits_required() требуется для расчёта значений, которые не являются чистой степенью двойки. К примеру, вам нужно сохранить набор из 110 различных символов. Для этого потребуется log(110) / log(2) == 6.781 бит, но поскольку бит для вычислительной техники является мельчайшей неделимой величиной, для отображения 110 различных значений нам понадобится 7 бит, при этом несколько значений останутся невостребованными.
Всё сказанное служит для обоснования одной идеи: ASCII, строго говоря, семибитная кодировка. Эта таблица содержит 128 кодовых точек, и, соответственно, символов, от 0 до 127 включительно. Это требует 7 бит:
Проблема заключается в том, что современные компьютеры не используют для хранения чего-либо семибитные последовательности. Основной единицей хранения информации современных вычислительных устройств являются восьмибитные последовательности, байты.
Прим. В этой статье под байтом подразумевается группа из 8 бит, как повелось с 60-х годов прошлого века. Если вам не по душе это новомодное название, можете называть их октетами.
То, что ASCII-таблица использует 7 бит из доступных 8, означает, что память вычислительного устройства, занятого строками символов ASCII, наполовину пуста. Для того, чтобы лучше понять, почему это происходит, вернитесь к приведённой выше таблице соответствия двоичных и десятичных чисел. Вы можете выразить числа 0 и 1 с помощью 1 бита, или вы можете использовать 8 бит, чтобы выразить их как 00000000 и 00000001 соответственно.
Прим. перев. Если быть точным, то пустой остаётся только одна восьмая часть памяти. Однако с помощью именно этого незадействованного бита можно было бы создать вдвое больше кодовых точек.
Вы можете выразить числа от 0 до 3 всего двумя битами, от 00 до 11, или использовать 8 бит, чтобы выразить их как 00000000, 00000001, 00000010 и 00000011. Самая большая кодовая точка ASCII, 127, требует только 7 значимых бит.
С учётом этого взгляните, как метод make_bitseq() преобразует строки ASCII в строки, состоящие из байт, где каждый символ требует один байт:
Неэффективное использование восьмибитной структуры памяти современных вычислительных устройств привело к появлению неструктурированного семейства конфликтующих кодировок, задействующих оставшуюся незанятой половину кодовых точек, доступных в одном байте.
Несмотря на попытку задействовать дополнительный бит, эти конфликтующие кодировки не могли отобразить все возможные символы, используемые человечеством в письменности.
Со временем появилась одна большая схема кодировки, которая объединила их. Однако, прежде чем мы до этого доберёмся, поговорим немного о краеугольных камнях схем кодировки символов — системах счисления.
Изучаем основы: другие системы счисления
В ASCII-таблице, как мы увидели, каждый символ соответствует числу от 0 до 127.
Этот диапазон чисел выражен в десятичной системе счисления. Именно эту систему используют для счёта люди, просто потому что на руках у нас по 10 пальцев.
Однако существуют и другие системы счисления, которые, в частности, широко используются в исходном коде CPython. Следует понимать, что действительное число не изменяется, а системы счисления просто по-разному его выражают.
Вопрос, какое число записано в строке «11» покажется странным, ведь для большинства очевидно, что это одиннадцать.
Однако в строке может быть представлено и другое число, в зависимости от системы счисления. Помимо десятичной, используются такие общепринятые альтернативы:
Что же мы подразумеваем, говоря что определённая система счисления имеет основу N?
Один из способов объяснения разных систем счисления заключается в том, чтобы представить, что у вас N пальцев.
Если же вам требуется более подробное объяснение систем счисления, обратитесь к книге Чарльза Петцольда «Код». В этой книге детально объясняются основы работы вычислительной техники.
Чаще в Python для обозначения того, что целое число представлено в системе счисления, отличной от десятичной, используют префиксы-литералы. Для каждой из трёх альтернативных систем существует свой литерал.
Тип литерала | Префикс | Пример |
---|---|---|
Нет | Нет | 11 |
Binary literal | 0b или 0B | 0b11 |
Octal literal | 0o или 0O | 0o11 |
Hex literal | 0x или 0X | 0x11 |
Десятичные | Двоичные | Восмеричные | Шестнадцатеричные |
---|---|---|---|
0b0 | 0o0 | 0x0 | |
1 | 0b1 | 0o1 | 0x1 |
2 | 0b10 | 0o2 | 0x2 |
3 | 0b11 | 0o3 | 0x3 |
4 | 0b100 | 0o4 | 0x4 |
5 | 0b101 | 0o5 | 0x5 |
6 | 0b110 | 0o6 | 0x6 |
7 | 0b111 | 0o7 | 0x7 |
8 | 0b1000 | 0o10 | 0x8 |
9 | 0b1001 | 0o11 | 0x9 |
10 | 0b1010 | 0o12 | 0xa |
11 | 0b1011 | 0o13 | 0xb |
12 | 0b1100 | 0o14 | 0xc |
13 | 0b1101 | 0o15 | 0xd |
14 | 0b1110 | 0o16 | 0xe |
15 | 0b1111 | 0o17 | 0xf |
16 | 0b10000 | 0o20 | 0x10 |
17 | 0b10001 | 0o21 | 0x11 |
18 | 0b10010 | 0o22 | 0x12 |
19 | 0b10011 | 0o23 | 0x13 |
20 | 0b10100 | 0o24 | 0x14 |
Кстати, вы можете сами убедиться, что подобные способы записи чисел очень часто используется в Стандартной Библиотеке Python. Найдите папку lib/python3.7/ в своей системе, перейдите в неё и введите команду:
Введение в Юникод
Как видите, проблема ASCII в том, что этой таблицы недостаточно для отображения знаков, символов и глифов, использующихся во всех языках и диалектах мира. Её недостаточно даже для английского языка.
Юникод служит тем же целям, что и ASCII, но содержит намного больший набор кодовых точек. В период времени между появлением ASCII и принятием Юникода использовалось ещё несколько различных кодировок, но рассматривать их подробно нет смысла, так как Юникод и одна из его схем, UTF-8, в настоящее время стали использоваться практически повсеместно.
Вы можете представить Юникод как расширенную версию ASCII-таблицы — с 1 114 112 возможными кодовыми точками, от 0 до 1 114 111. Это 17*(2 16 ) или 0x10ffff в шестнадцатеричном представлении. Фактически, ASCII является частью Юникода, так как первые 128 символов этих кодировок полностью совпадают.
Юникод содержит практически любой символ, который только можно представить, включая дополнительные непечатаемые. Например, кодовая точка 8207 соответствует отметке RTL, которая используется для смены направления письма. Она полезна в текстах, где абзацы на одном из европейских языков соседствуют с абзацами на арабских языках.
Прим. Кстати, если уж мы хотим быть совсем точны в деталях, то надо отметить ещё один факт. Исторически сложилось, что в Юникоде доступны только 1 111 998 кодовых точек.
Юникод и UTF-8
Довольно скоро стало понятно, что все необходимые символы невозможно вместить в таблицу, используя только один байт. Современные, более ёмкие кодировки требовали использования больших объёмов.
Ранее мы упоминали, что Юникод сам по себе не является кодировкой. И вот почему.
Юникод не содержит указаний по извлечению из текста бит, он работает только с кодовыми точками. В нём нет стандарта конверсии текста в двоичные данные и обратно.
Юникод является абстрактным стандартом кодировки. Для практического его применения чаще всего используют схему UTF-8. Стандарт Юникод (таблица соответствий символов кодовыми точкам) определяет несколько различных кодировок на основе единого набора символов.
Как и менее распространённые UTF-16 и UTF-32, UTF-8 — формат кодировки для отображения символов Юникода в двоичном виде, используя один или несколько байт на один символ. UTF-16 и UTF-32 мы обсудим чуть позже, но пока нам интересен UTF-8 как самый популярный формат.
Сначала требуется разобрать термины «кодирование» и «декодирование».
Кодирование и декодирование в Python 3
Тип данных str в Python 3 рассчитан на представление текста в удобном для чтения формате и может содержать любые символы Юникода.
Кодирование и декодирование — это процесс перехода данных из одной формы в другую.
Таким образом символ ñ требует два байта для бинарного представления с помощью UTF-8.
Python 3: всё на Юникоде
Python 3 полностью реализован на Юникоде, а точнее на UTF-8. Вот что это означает:
Мы делаем упор на эти моменты, чтобы вы вдруг не подумали, что кодировка UTF-8 является универсальной. Она действительно широко распространена, но вы вполне можете столкнуться и с другими вариантами. Не будет лишним предусмотреть это в коде.
Один байт, два байта, три байта, четыре…
Одна из важнейших особенностей UTF-8 состоит в том, что это кодировка с переменным размером.
Вспомните раздел, посвящённый ASCII. Любой символ в этой таблице требует максимум одного байта пространства. Это можно быстро проверить с помощью следующего генератора:
С UTF-8 дела обстоят по-другому. Символы Юникода могут занимать от одного до четырёх байт. Вот пример четырёхбайтного символа:
Это небольшая, но важная особенность метода len() :
Таблица ниже показывает, сколько байт занимают основные типы символов.
*Такие как английский, арабский, греческий, ирландский.
**Масса языков и символов, в основном китайский, японский и корейский с разделением по томам (а также ASCII и латиница).
***Дополнительные символы китайского, японского, корейского и вьетнамского, а также другие символы и эмоджи.
Прим. У UTF-8 есть и другие технические особенности. Те, кто работает на Python, редко с ними сталкиваются, поэтому мы не будем раскрывать их в этой статье, но упомянем вкратце, чтобы сохранить полноту картины. Так, UTF-8 использует коды-префиксы, указывающие на количество байт в последовательности. Такой приём позволяет декодеру группировать байты в условиях кодировки с переменным размером. Количество байт в последовательности определяется первым её байтом. Другие технические подробности можно найти на странице Википедии, посвящённой UTF-8 или на официальном сайте.
Особенности UTF-16 и UTF-32
Рассмотрим альтернативные кодировки, UTF-16 и UTF-32. Различие между ними и UTF-8 в основном практическое. Продемонстрируем величину расхождения с помощью перевода туда и обратно:
В данном случае, когда мы кодируем четыре буквы греческого алфавита в двоичные данные с помощью UTF-8, а декодируем обратно в текст с использованием UTF-16, на выходе получается строка с совершенно другими символами (из корейского алфавита).
Так происходит, если для кодирования и декодирования применяют разные кодировки. Два варианта декодирования одного бинарного объекта могут вернуть текст даже на другом языке.
Таблица ниже демонстрирует количество байт, используемых в разных кодировках:
Кодировка | Байт на символ (включительно) | Варьируемая длина |
---|---|---|
UTF-8 | От 1 до 4 | Да |
UTF-16 | От 2 до 4 | Да |
UTF-32 | 4 | Нет |
Любопытный аспект семейства UTF: UTF-8 не всегда занимает меньше памяти, чем UTF-16. Хотя с точки зрения математики это выглядит маловероятным, однако это возможно:
Так получается из-за того, что кодовые точки в диапазоне от U+0800 до U+FFFF (от 2048 до 65535 в десятичной системе) в кодировке UTF-8 занимают три байта, а в UTF-16 только два.
Это не означает, что нужно работать с UTF-16, независимо от того, насколько часто вы работаете с символами в этом диапазоне. Один из самых важных поводов придерживаться UTF-8 — в мире кодировок лучше держаться вместе с большинством.
Кроме того, в 2019 году компьютерная память стоит дёшево, и экономия четырёх байт за счёт использования нестандартной кодировки вряд ли стоит усилий.
Прим. перев. Есть и более весомые причины использовать UTF-8. Среди них её обратная совместимость с ASCII, а также то, что это самосинхронизирующаяся кодировка.
Python и встроенные функции
Вы освоили самую сложную часть статьи. Теперь посмотрим, как всё изученное реализуется на Python.
В Python есть несколько встроенных функций, каким-либо образом относящихся к системам счисления и кодировке:
Логически их можно сгруппировать по назначению.
В таблице ниже эти функции разобраны более подробно:
Функция | Форма | Тип аргументов | Тип возвращаемых данных | Назначение |
---|---|---|---|---|
ascii() | ascii(obj) | Различный | str | Представление объекта символами ASCII. Не входящие в таблицу символы экранируются |
bin() | bin(number) | number: int | str | Бинарное представление целого чиста с префиксом «0b» |
bytes() | bytes(последовательность_целых_чисел) |
bytes([i]) Различный bytes Приводит аргумент к двоичным данным, типу bytes chr() chr(i) i: int
i str Преобразует кодовую точку (целочисленное значение) в символ Юникода hex() hex(number) number: int str Шестнадцатеричное представление целого числа с префиксом «0x» int() int([x])
int(x, base=10) Различный int Приводит аргумент к типу int oct() oct(number) number: int str Восьмеричное представление целого числа с префиксом «0o» ord() ord(c) c: str
len(c) == 1 int Возвращает значение кодовой точки символа Юникода str() str(object=’‘)
str(b[, enc[, errors]]) Различный str Приводит аргумент к текстовому представлению, типу str
Дальше можно посмотреть полезные примеры использования этих функций.
Источник
Главная / Блог / Работа с файлами в Python
Работа с файлами в Python
Следить за результатами выполнения скрипта в консоли информативно, но не очень весело. Более того, после закрытия терминала весь итог работы кода исчезает. А хочется сохранить всё это куда-то на диск, чтобы потом в любое время рассмотреть повнимательнее. Да и простая задача «работать с файлами» может возникнуть в любое время.
В языке Python для этого предусмотрена встроенная функция open(). Она дает возможность чтения и записи файлов. Об этом ниже.
1. Начало работы
В качестве примера работы с файлами на ПК мы будем использовать war_and_peace.txt (начало романа Л. Н. Толстого «Война и мир»), который разместим в папке скрипта.
В общем виде для открытия файла функцией open() требуется указать либо его расположение относительно текущей директории либо задав абсолютный путь.
Пример – Интерактивный режим
>>> file = open('war_and_peace.txt')
>>> file.read(50)
†Eh bien, mon prince. Gênes et Lucques ne s
>>> file.read()
Тут выведется оставшаяся часть текста...
>>> file.read()
Получим пустую строку
>>> file.close()
Рассмотрим подробнее проделанные операции.
1. Мы открыли файл ‘war_and_peace.txt’ и присвоили его переменной file.
2. Далее мы вывели на печать первые 50 символов объекта. Если в метод read() не передать аргумент, то выведется весь файл. Если вы следом еще раз попытаетесь прочитать файл целиком и вывести на печать, то получите пустую строку (так как file.read() является итератором).
Обратите внимание на сам текст: в нем угадываются французские слова и непонятные кракозябры (к слову, у вас могут отобразиться совсем другие символы). Вывод: с кодировкой беда. Так как мы ее не задали явно, определилась та, которая задана системно. В приведенном выше примере функция open() открыла роман в кодировке cp1251. Но, у самого файла она другая – utf-8.
3. В конце мы закрыли файловый объект, чтобы он не занимал место в памяти.
Нам повезло, что до момента закрытия файла не случилось ошибки, иначе он бы так и остался открытым и занимал некоторый объем памяти.
Читайте также
2. Чтение файла целиком
Чтобы случайно не забыть закрыть файл, функция open() может открываться при помощи контекстного менеджера. Лучше пользоваться всегда таким способом как рекомендуемым разработчиками.
Попытаемся еще раз открыть файл, указав кодировку, режим (на чтение обозначается буквой r).
Пример – Интерактивный режим
>>> with open('war_and_peace.txt', 'r', encoding='utf-8') as file:
txt = file.read()
>>> txt[:50]
ufeff— Eh bien, mon prince. Gênes et Lucques ne sont p
>>> txt[:50]
ufeff— Eh bien, mon prince. Gênes et Lucques ne sont p
В данном случае код вне контекстного менеджера выполняется после закрытия файлового объекта и очистки памяти (даже если бы возникла ошибка).
Переменная txt имеет тип строка. В ней сохранились не только буквы и знаки препинания, но и все скрытые символы (перевод на новую строку, отступы и т.п.). Так как эта переменная хранит строку, то мы к ней можем обращаться любое количество раз.
Существует второй способ чтения файла целиком: через метод readlines(). Он возвращает список строк. Строки идентифицируются по символу ‘n’.
Пример – Интерактивный режим
>>> with open('war_and_peace.txt', 'r', encoding='utf-8') as file:
txt = file.readlines()
>>> txt[0]
"ufeff— Eh bien, mon prince. Gênes et Lucques ne sont plus que des apanages, des поместья, de la famille Buonaparte. Non, je vous préviens que si vous ne me dites pas que nous avons la guerre, si vous vous permettez encore de pallier toutes les infamies, toutes les atrocités de cet Antichrist (ma parole, j'y crois) — je ne vous connais plus, vous n'êtes plus mon ami, vous n'êtes plus мой верный раб, comme vous dites 1. Ну, здравствуйте, здравствуйте. Je vois que je vous fais peur 2, садитесь и рассказывайте.n"
Здесь мы вывели на печать первую строку файла.
Итак, теперь текст отображается правильно. Но, имеется еще один неприятный момент, на который не каждый обратит внимание. Наш файл – достаточно мал по объему. Поэтому мы оправданно присвоили всё его содержимое одной переменной. В случае огромных объектов (например, HD-фильм или база данных на сотню миллионов пользователей) это чревато переполнением памяти и возникновением ошибок.
3. Чтение файла частями
К счастью, файловый объект может читаться построчно при помощи readline(). Следовательно, мы можем посмотреть каждую строку тяжеловесного файла и проделать над ней какие-то операции.
Выведем на печать первые 50 символов двух первых строк.
Пример – Интерактивный режим
>>> with open('war_and_peace.txt', 'r', encoding='utf8') as file:
first_line = file.readline()
second_line = file.readline()
>>> first_line[:50]
ufeff— Eh bien, mon prince. Gênes et Lucques ne sont p
>>> second_line[:50]
Так говорила в июле 1805 года известная Анна Павло
Такой способ удобен, если нам не нужен весь файл, а лишь его часть. Главный минус – мы можем не знать, сколько строк в файле. А так как readline() не выдает ошибки при окончании текста, то будет просто возвращать пустые.
Если методу readline() передать числовой аргумент, то он посчитает окончанием строки это количество символов.
Чтение по строкам можно провести обычной итерацией в цикле по файловому объекту. Это может понадобиться, если нам требуется провести какие-то преобразования в каждой строке, но нужно прекратить их по окончании файла.
with open('war_and_peace.txt', 'r', encoding='utf8') as file:
for line in file:
print(line[:15].lower())
— eh bien, mon
так говорила в
«si vous n'avez
— dieu, quelle
он говорил на т
— avant tout di
— как можно быт
— а праздник ан
— я думала, что
— ежели бы знал
— ne me tourmen
— как вам сказа
князь василий г
быть энтузиастк
В примере выше мы прошлись по всем строкам текста и вывели на печать первые 15 символов каждой строки в нижнем регистре.
4. Запись в файл
Функция open() позволяет не только читать файлы, но и записывать. Для этого требуется сменить режим на w и использовать метод write(). К слову, этот метод принимает только строку в качестве аргумента. Запишем в файл четные числа от 2 до 19 (каждое число – в отдельную строку).
Пример – Интерактивный режим
>>> with open('even.txt', 'w', encoding='utf8') as file:
for num in range(2, 20, 2):
file.write(str(num))
В результате появится текстовый файл с четными числами. Но записаны они очень неудобно – в одну строку без пробелов: 24681012141618. Чтобы исправить положение, помимо записи самой строки требуется внести еще и символ окончания строки n.
Пример – Интерактивный режим
>>> with open('even.txt', 'w', encoding='utf8') as file:
for num in range(2, 20, 2):
file.write(str(num) + 'n')
Вот теперь файл выглядит так, как мы запланировали.
Такой способ, конечно, не всегда удобен. Некоторые предпочитают пользоваться другим вариантом записи текста в файл – через привычную функцию print().
Повторим задачу с ее использованием.
Пример – Интерактивный режим
>>> with open('even.txt', 'w', encoding='utf8') as file:
for num in range(2, 20, 2):
print(num, file=file)
По умолчанию функция print() выводит информацию (в большинстве случаев текстовую) в поток STDOUT на устройство отображения (монитор). В нашем случае мы его перенаправляем на файловый объект(поток) file.
Используя методику записи в файл нужно понимать, что если файла нет – то он создается, если же он есть, то все его содержимое удаляется и перезаписывается. А, вдруг, вы забыли переименовать документ и случайно переписали его содержимое? Мало приятного.
Избежать такой беды можно использованием режима x.
Пример – Интерактивный режим
>>> with open('even.txt', 'x', encoding='utf8') as file:
for num in range(2, 20, 2):
print(num, file=file)
При исполнении кода возникнет ошибка FileExistsError, говорящая о том, что такой файл уже имеется на диске. Поэтому либо создавайте документ с другим наименованием, либо удаляйте старый.
5. Дозапись в файл
Не всегда требуется записывать в файл единоразово. Во многих ситуациях нужно дополнять имеющийся документ новым контентом (при парсинге, логировании и т.п.). На помощь приходит режим a.
Так как выше мы уже имеем файл с четными числами до 18, дополним его четными числами до 100 включительно.
Пример – Интерактивный режим
>>> with open('even.txt', 'x', encoding='utf8') as file:
for num in range(2, 20, 2):
print(num, file=file)
В документе even.txt теперь имеются все четные числа от 2 до 100.
В статье приведены базовые основы работы с файлами Python на примере функции open(). Она намного сложнее, имеет дополнительные режимы, позволяет взаимодействовать не только с текстовыми документами формата txt, но и любыми другими типами данных (картинками, медиафайлами, excel-таблицами, html-страницами и т.д.).
Как вам материал?