twisted.web.test.test_static.StaticFileTests(TestCase)
class documentationtwisted.web.test.test_static
(View In Hierarchy)
Tests for the basic behavior of File
.
Method | test_ignoredExtTrue | Passing 1 as the value to File 's
ignoredExts argument issues a warning and sets the ignored
extensions to the wildcard "*" . |
Method | test_ignoredExtFalse | Passing 1 as the value to File 's
ignoredExts argument issues a warning and sets the ignored
extensions to the empty list. |
Method | test_allowExt | Passing 1 as the value to File 's
allowExt argument issues a warning and sets the ignored
extensions to the wildcard * . |
Method | test_invalidMethod | File.render raises UnsupportedMethod
in response to a non-GET, non-HEAD request. |
Method | test_notFound | If a request is made which encounters a File before a final
segment which does not correspond to any file in the path the File was created with,
a not found response is sent. |
Method | test_emptyChild | The '' child of a File which corresponds
to a directory in the filesystem is a DirectoryLister . |
Method | test_emptyChildUnicodeParent | The u'' child of a File which corresponds
to a directory whose path is text is a DirectoryLister
that renders to a binary listing. |
Method | test_securityViolationNotFound | If a request is made which encounters a File before a final
segment which cannot be looked up in the filesystem due to security
considerations, a not found response is sent. |
Method | test_forbiddenResource | If the file in the filesystem which would satisfy a request cannot be
read, File.render sets the HTTP response code to
FORBIDDEN. |
Method | test_undecodablePath | A request whose path cannot be decoded as UTF-8 receives a not found response, and the failure is logged. |
Method | test_forbiddenResource_default | File.forbidden
defaults to resource.ForbiddenResource . |
Method | test_forbiddenResource_customize | The resource rendered for forbidden requests is stored as a class member so that users can customize it. |
Method | test_indexNames | No summary |
Method | test_staticFile | If a request is made which encounters a File before a final
segment which names a file in the path the File was created with,
that file is served as the response to the request. |
Method | test_staticFileUnicodeFileName | A request for a existing unicode file path encoded as UTF-8 returns the contents of that file. |
Method | test_staticFileDeletedGetChild | A static.File
created for a directory which does not exist should return childNotFound
from static.File.getChild . |
Method | test_staticFileDeletedRender | A static.File
created for a file which does not exist should render its
childNotFound page. |
Method | test_getChildChildNotFound_customize | The resource rendered for child not found requests can be customize using a class member. |
Method | test_headRequest | static.File.render returns an empty response body for
HEAD requests. |
Method | test_processors | No summary |
Method | test_ignoreExt | The list of ignored extensions can be set by passing a value to File.__init__
or by calling File.ignoreExt
later. |
Method | test_ignoredExtensionsIgnored | No summary |
Method | test_directoryWithoutTrailingSlashRedirects | A request for a path which is a directory but does not have a trailing
slash will be redirected to a URL which does have a slash by File . |
Method | test_HEADClosesFile | A HEAD request opens the file, gets the size, and then closes it after the request. |
Method | test_cachedRequestClosesFile | A GET request that is cached closes the file after the request. |
Method | _render | Undocumented |
Method | _makeFilePathWithStringIO | Create a File
that when opened for reading, returns a StringIO . |
Inherited from TestCase:
Instance Variable | timeout | A real number of seconds. If set, the test will raise an error if it takes
longer than timeout seconds. If not set,
util.DEFAULT_TIMEOUT_DURATION is used. |
Method | __init__ | Construct an asynchronous test case for methodName . |
Method | assertFailure | Fail if deferred does not errback with one of
expectedFailures . Returns the original Deferred with callbacks
added. You will need to return this Deferred from your test case. |
Method | __call__ | Run the test. Should always do exactly the same thing as run(). |
Method | deferSetUp | Undocumented |
Method | deferTestMethod | Undocumented |
Method | deferTearDown | Undocumented |
Method | deferRunCleanups | Run any scheduled cleanups and report errors (if any to the result object. |
Method | addCleanup | Extend the base cleanup feature with support for cleanup functions which return Deferreds. |
Method | getSuppress | Undocumented |
Method | getTimeout | No summary |
Method | _run | Run a single method, either a test method or fixture. |
Method | _ebDeferSetUp | Undocumented |
Method | _cbDeferTestMethod | Undocumented |
Method | _ebDeferTestMethod | Undocumented |
Method | _ebDeferTearDown | Undocumented |
Method | _cbDeferRunCleanups | Undocumented |
Method | _cleanUp | Undocumented |
Method | _classCleanUp | Undocumented |
Method | _makeReactorMethod | Create a method which wraps the reactor method name . The
new method issues a deprecation warning and calls the original. |
Method | _deprecateReactor | Deprecate iterate , crash and stop
on reactor . That is, each method is wrapped in a function that
issues a deprecation warning, then calls the original. |
Method | _undeprecateReactor | Restore the deprecated reactor methods. Undoes what _deprecateReactor
did. |
Method | _runCleanups | Run the cleanups added with addCleanup
in order. |
Method | _runFixturesAndTest | Really run setUp , the test method, and
tearDown . Any of these may return defer.Deferred s.
After they complete, do some reactor cleanup. |
Method | _wait | Take a Deferred that only ever callbacks. Block until it happens. |
Inherited from SynchronousTestCase (via TestCase):
Instance Variable | failureException | An exception class, defaulting to FailTest . If the test method
raises this exception, it will be reported as a failure, rather than an
exception. All of the assertion methods raise this if the assertion fails. |
Instance Variable | skip | None
or a string explaining why this test is to be skipped. If defined, the test
will not be run. Instead, it will be reported to the result object as
'skipped' (if the TestResult supports skipping). |
Instance Variable | todo | None ,
a string or a tuple of (errors, reason) where
errors is either an exception class or an iterable of
exception classes, and reason is a string. See Todo or makeTodo for
more information. |
Instance Variable | suppress | None
or a list of tuples of (args, kwargs) to be passed to
warnings.filterwarnings . Use these to suppress warnings raised
in a test. Useful for testing deprecated code. See also util.suppress . |
Method | __eq__ | No summary |
Method | __ne__ | Undocumented |
Method | __hash__ | Undocumented |
Method | shortDescription | Undocumented |
Method | getSkip | No summary |
Method | getTodo | No summary |
Method | runTest | If no methodName argument is passed to the constructor, run
will treat this method as the thing with the actual test inside. |
Method | run | Run the test case, storing the results in result . |
Method | patch | Monkey patch an object for the duration of the test. |
Method | flushLoggedErrors | Remove stored errors received from the log. |
Method | flushWarnings | Remove stored warnings from the list of captured warnings and return them. |
Method | callDeprecated | Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated. |
Method | mktemp | Create a new path name which can be used for a new file or directory. |
Method | _getSuppress | No summary |
Method | _getSkipReason | Return the reason to use for skipping a test method. |
Method | _installObserver | Undocumented |
Method | _removeObserver | Undocumented |
Inherited from _Assertions (via TestCase, SynchronousTestCase):
Method | fail | Absolutely fail the test. Do not pass go, do not collect $200. |
Method | assertFalse | Fail the test if condition evaluates to True. |
Method | assertTrue | Fail the test if condition evaluates to False. |
Method | assertRaises | Fail the test unless calling the function f with the given
args and kwargs raises exception .
The failure will report the traceback and call stack of the unexpected
exception. |
Method | assertEqual | Fail the test if first and second are not
equal. |
Method | assertIs | Fail the test if first is not second . This is
an obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method | assertIsNot | Fail the test if first is second . This is an
obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method | assertNotEqual | Fail the test if first == second . |
Method | assertIn | Fail the test if containee is not found in
container . |
Method | assertNotIn | Fail the test if containee is found in
container . |
Method | assertNotAlmostEqual | Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero. |
Method | assertAlmostEqual | Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero. |
Method | assertApproximates | Fail if first - second >
tolerance |
Method | assertSubstring | Fail if substring does not exist within
astring . |
Method | assertNotSubstring | Fail if astring contains substring . |
Method | assertWarns | Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine. |
Method | assertIsInstance | Fail if instance is not an instance of the given class or
of one of the given classes. |
Method | assertNotIsInstance | Fail if instance is an instance of the given class or of
one of the given classes. |
Method | successResultOf | Return the current success result of deferred or raise
self.failureException . |
Method | failureResultOf | Return the current failure result of deferred or raise
self.failureException . |
Method | assertNoResult | Assert that deferred does not have a result at this
point. |
Method | assertRegex | Fail the test if a regexp search of text
fails. |
Passing 1
as the value to File
's
ignoredExts
argument issues a warning and sets the ignored
extensions to the wildcard "*"
.
Passing 1
as the value to File
's
ignoredExts
argument issues a warning and sets the ignored
extensions to the empty list.
Passing 1
as the value to File
's
allowExt
argument issues a warning and sets the ignored
extensions to the wildcard *
.
File.render
raises UnsupportedMethod
in response to a non-GET, non-HEAD request.
The ''
child of a File
which corresponds
to a directory in the filesystem is a DirectoryLister
.
The u''
child of a File
which corresponds
to a directory whose path is text is a DirectoryLister
that renders to a binary listing.
See Also | https://twistedmatrix.com/trac/ticket/9438 |
If a request is made which encounters a File
before a final
segment which cannot be looked up in the filesystem due to security
considerations, a not found response is sent.
If the file in the filesystem which would satisfy a request cannot be
read, File.render
sets the HTTP response code to
FORBIDDEN.
A request whose path cannot be decoded as UTF-8 receives a not found response, and the failure is logged.
The resource rendered for forbidden requests is stored as a class member so that users can customize it.
A request for a existing unicode file path encoded as UTF-8 returns the contents of that file.
A static.File
created for a directory which does not exist should return childNotFound
from static.File.getChild
.
A static.File
created for a file which does not exist should render its
childNotFound
page.
The resource rendered for child not found requests can be customize using a class member.
The list of ignored extensions can be set by passing a value to File.__init__
or by calling File.ignoreExt
later.
A request for a path which is a directory but does not have a trailing
slash will be redirected to a URL which does have a slash by File
.