Browse Source

Fix inconsistent capitalisation and punctuation in attribute docstrings

pull/124/head
Dag Odenhall 15 years ago committed by Armin Ronacher
parent
commit
51a5add86d
  1. 42
      flask.py

42
flask.py

@ -448,11 +448,11 @@ else:
class _PackageBoundObject(object): class _PackageBoundObject(object):
def __init__(self, import_name): def __init__(self, import_name):
#: the name of the package or module. Do not change this once #: The name of the package or module. Do not change this once
#: it was set by the constructor. #: it was set by the constructor.
self.import_name = import_name self.import_name = import_name
#: where is the app root located? #: Where is the app root located?
self.root_path = _get_package_path(self.import_name) self.root_path = _get_package_path(self.import_name)
def open_resource(self, resource): def open_resource(self, resource):
@ -788,20 +788,20 @@ class Flask(_PackageBoundObject):
app = Flask(__name__) app = Flask(__name__)
""" """
#: the class that is used for request objects. See :class:`~flask.Request` #: The class that is used for request objects. See :class:`~flask.Request`
#: for more information. #: for more information.
request_class = Request request_class = Request
#: the class that is used for response objects. See #: The class that is used for response objects. See
#: :class:`~flask.Response` for more information. #: :class:`~flask.Response` for more information.
response_class = Response response_class = Response
#: path for the static files. If you don't want to use static files #: Path for the static files. If you don't want to use static files
#: you can set this value to `None` in which case no URL rule is added #: you can set this value to `None` in which case no URL rule is added
#: and the development server will no longer serve any static files. #: and the development server will no longer serve any static files.
static_path = '/static' static_path = '/static'
#: the debug flag. Set this to `True` to enable debugging of the #: The debug flag. Set this to `True` to enable debugging of the
#: application. In debug mode the debugger will kick in when an unhandled #: application. In debug mode the debugger will kick in when an unhandled
#: exception ocurrs and the integrated server will automatically reload #: exception ocurrs and the integrated server will automatically reload
#: the application if changes in the code are detected. #: the application if changes in the code are detected.
@ -810,7 +810,7 @@ class Flask(_PackageBoundObject):
#: configuration key. Defaults to `False`. #: configuration key. Defaults to `False`.
debug = ConfigAttribute('DEBUG') debug = ConfigAttribute('DEBUG')
#: if a secret key is set, cryptographic components can use this to #: If a secret key is set, cryptographic components can use this to
#: sign cookies and other things. Set this to a complex random value #: sign cookies and other things. Set this to a complex random value
#: when you want to use the secure cookie for instance. #: when you want to use the secure cookie for instance.
#: #:
@ -818,7 +818,7 @@ class Flask(_PackageBoundObject):
#: `SECRET_KEY` configuration key. Defaults to `None`. #: `SECRET_KEY` configuration key. Defaults to `None`.
secret_key = ConfigAttribute('SECRET_KEY') secret_key = ConfigAttribute('SECRET_KEY')
#: The secure cookie uses this for the name of the session cookie #: The secure cookie uses this for the name of the session cookie.
#: #:
#: This attribute can also be configured from the config with the #: This attribute can also be configured from the config with the
#: `SESSION_COOKIE_NAME` configuration key. Defaults to ``'session'`` #: `SESSION_COOKIE_NAME` configuration key. Defaults to ``'session'``
@ -843,13 +843,13 @@ class Flask(_PackageBoundObject):
#: `USE_X_SENDFILE` configuration key. Defaults to `False`. #: `USE_X_SENDFILE` configuration key. Defaults to `False`.
use_x_sendfile = ConfigAttribute('USE_X_SENDFILE') use_x_sendfile = ConfigAttribute('USE_X_SENDFILE')
#: the name of the logger to use. By default the logger name is the #: The name of the logger to use. By default the logger name is the
#: package name passed to the constructor. #: package name passed to the constructor.
#: #:
#: .. versionadded:: 0.4 #: .. versionadded:: 0.4
logger_name = ConfigAttribute('LOGGER_NAME') logger_name = ConfigAttribute('LOGGER_NAME')
#: the logging format used for the debug logger. This is only used when #: The logging format used for the debug logger. This is only used when
#: the application is in debug mode, otherwise the attached logging #: the application is in debug mode, otherwise the attached logging
#: handler does the formatting. #: handler does the formatting.
#: #:
@ -861,13 +861,13 @@ class Flask(_PackageBoundObject):
'-' * 80 '-' * 80
) )
#: options that are passed directly to the Jinja2 environment #: Options that are passed directly to the Jinja2 environment.
jinja_options = ImmutableDict( jinja_options = ImmutableDict(
autoescape=True, autoescape=True,
extensions=['jinja2.ext.autoescape', 'jinja2.ext.with_'] extensions=['jinja2.ext.autoescape', 'jinja2.ext.with_']
) )
#: default configuration parameters #: Default configuration parameters.
default_config = ImmutableDict({ default_config = ImmutableDict({
'DEBUG': False, 'DEBUG': False,
'SECRET_KEY': None, 'SECRET_KEY': None,
@ -880,29 +880,29 @@ class Flask(_PackageBoundObject):
def __init__(self, import_name): def __init__(self, import_name):
_PackageBoundObject.__init__(self, import_name) _PackageBoundObject.__init__(self, import_name)
#: the configuration dictionary as :class:`Config`. This behaves #: The configuration dictionary as :class:`Config`. This behaves
#: exactly like a regular dictionary but supports additional methods #: exactly like a regular dictionary but supports additional methods
#: to load a config from files. #: to load a config from files.
self.config = Config(self.root_path, self.default_config) self.config = Config(self.root_path, self.default_config)
#: prepare the deferred setup of the logger #: Prepare the deferred setup of the logger.
self._logger = None self._logger = None
self.logger_name = self.import_name self.logger_name = self.import_name
#: a dictionary of all view functions registered. The keys will #: A dictionary of all view functions registered. The keys will
#: be function names which are also used to generate URLs and #: be function names which are also used to generate URLs and
#: the values are the function objects themselves. #: the values are the function objects themselves.
#: to register a view function, use the :meth:`route` decorator. #: to register a view function, use the :meth:`route` decorator.
self.view_functions = {} self.view_functions = {}
#: a dictionary of all registered error handlers. The key is #: A dictionary of all registered error handlers. The key is
#: be the error code as integer, the value the function that #: be the error code as integer, the value the function that
#: should handle that error. #: should handle that error.
#: To register a error handler, use the :meth:`errorhandler` #: To register a error handler, use the :meth:`errorhandler`
#: decorator. #: decorator.
self.error_handlers = {} self.error_handlers = {}
#: a dictionary with lists of functions that should be called at the #: A dictionary with lists of functions that should be called at the
#: beginning of the request. The key of the dictionary is the name of #: beginning of the request. The key of the dictionary is the name of
#: the module this function is active for, `None` for all requests. #: the module this function is active for, `None` for all requests.
#: This can for example be used to open database connections or #: This can for example be used to open database connections or
@ -910,7 +910,7 @@ class Flask(_PackageBoundObject):
#: function here, use the :meth:`before_request` decorator. #: function here, use the :meth:`before_request` decorator.
self.before_request_funcs = {} self.before_request_funcs = {}
#: a dictionary with lists of functions that should be called after #: A dictionary with lists of functions that should be called after
#: each request. The key of the dictionary is the name of the module #: each request. The key of the dictionary is the name of the module
#: this function is active for, `None` for all requests. This can for #: this function is active for, `None` for all requests. This can for
#: example be used to open database connections or getting hold of the #: example be used to open database connections or getting hold of the
@ -918,7 +918,7 @@ class Flask(_PackageBoundObject):
#: :meth:`before_request` decorator. #: :meth:`before_request` decorator.
self.after_request_funcs = {} self.after_request_funcs = {}
#: a dictionary with list of functions that are called without argument #: A dictionary with list of functions that are called without argument
#: to populate the template context. They key of the dictionary is the #: to populate the template context. They key of the dictionary is the
#: name of the module this function is active for, `None` for all #: name of the module this function is active for, `None` for all
#: requests. Each returns a dictionary that the template context is #: requests. Each returns a dictionary that the template context is
@ -928,7 +928,7 @@ class Flask(_PackageBoundObject):
None: [_default_template_ctx_processor] None: [_default_template_ctx_processor]
} }
#: the :class:`~werkzeug.routing.Map` for this instance. You can use #: The :class:`~werkzeug.routing.Map` for this instance. You can use
#: this to change the routing converters after the class was created #: this to change the routing converters after the class was created
#: but before any routes are connected. Example:: #: but before any routes are connected. Example::
#: #:
@ -956,7 +956,7 @@ class Flask(_PackageBoundObject):
self.static_path: target self.static_path: target
}) })
#: the Jinja2 environment. It is created from the #: The Jinja2 environment. It is created from the
#: :attr:`jinja_options` and the loader that is returned #: :attr:`jinja_options` and the loader that is returned
#: by the :meth:`create_jinja_loader` function. #: by the :meth:`create_jinja_loader` function.
self.jinja_env = Environment(loader=self.create_jinja_loader(), self.jinja_env = Environment(loader=self.create_jinja_loader(),

Loading…
Cancel
Save