我要学python之上下文管理

Posted 2021-01-07

上下文管理

我们通常在写jdbc连接的时候都会写打开连接，使用连接，关闭连接。为了把资源合理利用，同时这些打开，关闭的工作是重复的工作，那么这些活能不能交给工具去做呢？答案肯定是可以的，不然怎么会有那么多的数据层中间件呢？我们要说的这个python的上下文管理也不是深新鲜概念，我们看下如下python代码：

import contextlib

@contextlib.contextmanager
def show():
    print("open file")
    yield
    print("close file")

with show():
    print("start writing file...")

输出结果:
open file
start writing file...
close file

分析下上面的代码，我们不难看出，这个就是我们说的，把一些简单频繁却很重要的工作交给工具去做的一个简单模型。我们再来看下面的代码：

with open(‘index.log‘, ‘w‘) as f:
    f.write(‘start writing log...‘)

通常我们写文件我们需要打开文件，写文件，关闭文件。那么这个过程就是跟我们jdbc类似。上面的代码就是通过内置函数open打开文件，我们只要关心写文件，而打开文件、关闭文件都是交给上下文管理去做呢。我们可以看open文档，如下：

def open(file, mode=‘r‘, buffering=None, encoding=None, errors=None, newline=None, closefd=True): # known special case of open
    """
    Open file and return a stream.  Raise IOError upon failure.

    file is either a text or byte string giving the name (and the path
    if the file isn‘t in the current working directory) of the file to
    be opened or an integer file descriptor of the file to be
    wrapped. (If a file descriptor is given, it is closed when the
    returned I/O object is closed, unless closefd is set to False.)

    mode is an optional string that specifies the mode in which the file
    is opened. It defaults to ‘r‘ which means open for reading in text
    mode.  Other common values are ‘w‘ for writing (truncating the file if
    it already exists), ‘x‘ for creating and writing to a new file, and
    ‘a‘ for appending (which on some Unix systems, means that all writes
    append to the end of the file regardless of the current seek position).
    In text mode, if encoding is not specified the encoding used is platform
    dependent: locale.getpreferredencoding(False) is called to get the
    current locale encoding. (For reading and writing raw bytes use binary
    mode and leave encoding unspecified.) The available modes are:

    ========= ===============================================================
    Character Meaning
    --------- ---------------------------------------------------------------
    ‘r‘       open for reading (default)
    ‘w‘       open for writing, truncating the file first
    ‘x‘       create a new file and open it for writing
    ‘a‘       open for writing, appending to the end of the file if it exists
    ‘b‘       binary mode
    ‘t‘       text mode (default)
    ‘+‘       open a disk file for updating (reading and writing)
    ‘U‘       universal newline mode (deprecated)
    ========= ===============================================================

    The default mode is ‘rt‘ (open for reading text). For binary random
    access, the mode ‘w+b‘ opens and truncates the file to 0 bytes, while
    ‘r+b‘ opens the file without truncation. The ‘x‘ mode implies ‘w‘ and
    raises an `FileExistsError` if the file already exists.

    Python distinguishes between files opened in binary and text modes,
    even when the underlying operating system doesn‘t. Files opened in
    binary mode (appending ‘b‘ to the mode argument) return contents as
    bytes objects without any decoding. In text mode (the default, or when
    ‘t‘ is appended to the mode argument), the contents of the file are
    returned as strings, the bytes having been first decoded using a
    platform-dependent encoding or using the specified encoding if given.

    ‘U‘ mode is deprecated and will raise an exception in future versions
    of Python.  It has no effect in Python 3.  Use newline to control
    universal newlines mode.

    buffering is an optional integer used to set the buffering policy.
    Pass 0 to switch buffering off (only allowed in binary mode), 1 to select
    line buffering (only usable in text mode), and an integer > 1 to indicate
    the size of a fixed-size chunk buffer.  When no buffering argument is
    given, the default buffering policy works as follows:

    * Binary files are buffered in fixed-size chunks; the size of the buffer
      is chosen using a heuristic trying to determine the underlying device‘s
      "block size" and falling back on `io.DEFAULT_BUFFER_SIZE`.
      On many systems, the buffer will typically be 4096 or 8192 bytes long.

    * "Interactive" text files (files for which isatty() returns True)
      use line buffering.  Other text files use the policy described above
      for binary files.

    encoding is the name of the encoding used to decode or encode the
    file. This should only be used in text mode. The default encoding is
    platform dependent, but any encoding supported by Python can be
    passed.  See the codecs module for the list of supported encodings.

    errors is an optional string that specifies how encoding errors are to
    be handled---this argument should not be used in binary mode. Pass
    ‘strict‘ to raise a ValueError exception if there is an encoding error
    (the default of None has the same effect), or pass ‘ignore‘ to ignore
    errors. (Note that ignoring encoding errors can lead to data loss.)
    See the documentation for codecs.register or run ‘help(codecs.Codec)‘
    for a list of the permitted encoding error strings.

    newline controls how universal newlines works (it only applies to text
    mode). It can be None, ‘‘, ‘
‘, ‘
‘, and ‘
‘.  It works as
    follows:

    * On input, if newline is None, universal newlines mode is
      enabled. Lines in the input can end in ‘
‘, ‘
‘, or ‘
‘, and
      these are translated into ‘
‘ before being returned to the
      caller. If it is ‘‘, universal newline mode is enabled, but line
      endings are returned to the caller untranslated. If it has any of
      the other legal values, input lines are only terminated by the given
      string, and the line ending is returned to the caller untranslated.

    * On output, if newline is None, any ‘
‘ characters written are
      translated to the system default line separator, os.linesep. If
      newline is ‘‘ or ‘
‘, no translation takes place. If newline is any
      of the other legal values, any ‘
‘ characters written are translated
      to the given string.

    If closefd is False, the underlying file descriptor will be kept open
    when the file is closed. This does not work when a file name is given
    and must be True in that case.

    A custom opener can be used by passing a callable as *opener*. The
    underlying file descriptor for the file object is then obtained by
    calling *opener* with (*file*, *flags*). *opener* must return an open
    file descriptor (passing os.open as *opener* results in functionality
    similar to passing None).

    open() returns a file object whose type depends on the mode, and
    through which the standard file operations such as reading and writing
    are performed. When open() is used to open a file in a text mode (‘w‘,
    ‘r‘, ‘wt‘, ‘rt‘, etc.), it returns a TextIOWrapper. When used to open
    a file in a binary mode, the returned class varies: in read binary
    mode, it returns a BufferedReader; in write binary and append binary
    modes, it returns a BufferedWriter, and in read/write mode, it returns
    a BufferedRandom.

    It is also possible to use a string or bytearray as a file for both
    reading and writing. For strings StringIO can be used like a file
    opened in a text mode, and for bytes a BytesIO can be used like a file
    opened in a binary mode.
    """
    pass

open函数做的事情就是按照指定模式打开一个文件，并返回一个文件流。跟多详细的信息我就不在此重复翻译了，可自行阅读上面的open文档。