booman.create
index
booman/create.py

# Boodler: a programmable soundscape tool
# Copyright 2007-2011 by Andrew Plotkin <erkyrath@eblong.com>
#   <http://boodler.org/>
# This program is distributed under the LGPL.
# See the LGPL document, or the above URL, for details.

 
Modules
       
boopak.argdef
booman
boopak.collect
inspect
keyword
os
boopak.pinfo
boopak.pload
re
types
unittest

 
Classes
       
booman.CommandError(builtins.Exception)
ConstructError
builtins.object
WalkContext
unittest.case.TestCase(builtins.object)
TestCreate

 
class ConstructError(booman.CommandError)
    ConstructError(dirname, msg)
 
ConstructError: represents an error during package construction.
 
 
Method resolution order:
ConstructError
booman.CommandError
builtins.Exception
builtins.BaseException
builtins.object

Methods defined here:
__init__(self, dirname, msg)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors inherited from booman.CommandError:
__weakref__
list of weak references to the object (if defined)

Static methods inherited from builtins.Exception:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
Helper for pickle.
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TestCreate(unittest.case.TestCase)
    TestCreate(methodName='runTest')
 
A class whose instances are single test cases.
 
By default, the test code itself should be placed in a method named
'runTest'.
 
If the fixture may be used for many test cases, create as
many test methods as are needed. When instantiating such a TestCase
subclass, specify in the constructor arguments the name of the test method
that the instance is to execute.
 
Test authors should subclass TestCase for their own tests. Construction
and deconstruction of the test's environment ('fixture') can be
implemented by overriding the 'setUp' and 'tearDown' methods respectively.
 
If it is necessary to override the __init__ method, the base class
__init__ method must always be called. It is important that subclasses
should not change the signature of their __init__ method, since instances
of the classes are instantiated automatically by parts of the framework
in order to be run.
 
When subclassing TestCase, you can set these attributes:
* failureException: determines which exception will be raised when
    the instance's assertion methods fail; test methods raising this
    exception will be deemed to have 'failed' rather than 'errored'.
* longMessage: determines whether long messages (including repr of
    objects used in assert methods) will be printed on failure in *addition*
    to any explicit message passed.
* maxDiff: sets the maximum length of a diff in failure messages
    by assert methods using difflib. It is looked up as an instance
    attribute so can be configured by individual tests if required.
 
 
Method resolution order:
TestCreate
unittest.case.TestCase
builtins.object

Methods defined here:
test_build_package_filename(self)
test_parse_package_filename(self)
test_parse_package_filename_assume(self)
test_parse_package_filename_bad(self)

Methods inherited from unittest.case.TestCase:
__call__(self, *args, **kwds)
Call self as a function.
__eq__(self, other)
Return self==value.
__hash__(self)
Return hash(self).
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
method when executed. Raises a ValueError if the instance does
not have a method with the specified name.
__repr__(self)
Return repr(self).
__str__(self)
Return str(self).
addCleanup(*args, **kwargs)
Add a function, with arguments, to be called when the test is
completed. Functions added are called on a LIFO basis and are
called after tearDown on test failure or success.
 
Cleanup items are called even if setUp fails (unlike tearDown).
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
 
This method is for use by TestCase subclasses that need to register
their own type equality functions to provide nicer error messages.
 
Args:
    typeobj: The data type to call this function on when both values
            are of the same type in assertEqual().
    function: The callable taking two arguments and an optional
            msg= argument that raises self.failureException with a
            useful error message when the two arguments are not equal.
assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
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, or by comparing that the
difference between the two objects is more than the given
delta.
 
Note that decimal places (from zero) are usually not the same
as significant digits (measured from the most significant digit).
 
If the two objects compare equal then they will automatically
compare almost equal.
assertAlmostEquals = deprecated_func(*args, **kwargs)
assertCountEqual(self, first, second, msg=None)
An unordered sequence comparison asserting that the same elements,
regardless of order.  If the same element occurs more than once,
it verifies that the elements occur the same number of times.
 
    self.assertEqual(Counter(list(first)),
                     Counter(list(second)))
 
 Example:
    - [0, 1, 1] and [1, 0, 1] compare equal.
    - [0, 0, 1] and [0, 1] compare unequal.
assertDictContainsSubset(self, subset, dictionary, msg=None)
Checks whether dictionary is a superset of subset.
assertDictEqual(self, d1, d2, msg=None)
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
operator.
assertEquals = deprecated_func(*args, **kwargs)
assertFalse(self, expr, msg=None)
Check that the expression is false.
assertGreater(self, a, b, msg=None)
Just like self.assertTrue(a > b), but with a nicer default message.
assertGreaterEqual(self, a, b, msg=None)
Just like self.assertTrue(a >= b), but with a nicer default message.
assertIn(self, member, container, msg=None)
Just like self.assertTrue(a in b), but with a nicer default message.
assertIs(self, expr1, expr2, msg=None)
Just like self.assertTrue(a is b), but with a nicer default message.
assertIsInstance(self, obj, cls, msg=None)
Same as self.assertTrue(isinstance(obj, cls)), with a nicer
default message.
assertIsNone(self, obj, msg=None)
Same as self.assertTrue(obj is None), with a nicer default message.
assertIsNot(self, expr1, expr2, msg=None)
Just like self.assertTrue(a is not b), but with a nicer default message.
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
assertLess(self, a, b, msg=None)
Just like self.assertTrue(a < b), but with a nicer default message.
assertLessEqual(self, a, b, msg=None)
Just like self.assertTrue(a <= b), but with a nicer default message.
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
 
Args:
    list1: The first list to compare.
    list2: The second list to compare.
    msg: Optional message to use on failure instead of a list of
            differences.
assertLogs(self, logger=None, level=None)
Fail unless a log message of level *level* or higher is emitted
on *logger_name* or its children.  If omitted, *level* defaults to
INFO and *logger* defaults to the root logger.
 
This method must be used as a context manager, and will yield
a recording object with two attributes: `output` and `records`.
At the end of the context manager, the `output` attribute will
be a list of the matching formatted log messages and the
`records` attribute will be a list of the corresponding LogRecord
objects.
 
Example::
 
    with self.assertLogs('foo', level='INFO') as cm:
        logging.getLogger('foo').info('first message')
        logging.getLogger('foo.bar').error('second message')
    self.assertEqual(cm.output, ['INFO:foo:first message',
                                 'ERROR:foo.bar:second message'])
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
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, or by comparing that the
difference between the two objects is less than the given delta.
 
Note that decimal places (from zero) are usually not the same
as significant digits (measured from the most significant digit).
 
Objects that are equal automatically fail.
assertNotAlmostEquals = deprecated_func(*args, **kwargs)
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '!='
operator.
assertNotEquals = deprecated_func(*args, **kwargs)
assertNotIn(self, member, container, msg=None)
Just like self.assertTrue(a not in b), but with a nicer default message.
assertNotIsInstance(self, obj, cls, msg=None)
Included for symmetry with assertIsInstance.
assertNotRegex(self, text, unexpected_regex, msg=None)
Fail the test if the text matches the regular expression.
assertNotRegexpMatches = deprecated_func(*args, **kwargs)
assertRaises(self, expected_exception, *args, **kwargs)
Fail unless an exception of class expected_exception is raised
by the callable when invoked with specified positional and
keyword arguments. If a different type of exception is
raised, it will not be caught, and the test case will be
deemed to have suffered an error, exactly as for an
unexpected exception.
 
If called with the callable and arguments omitted, will return a
context object used like this::
 
     with self.assertRaises(SomeException):
         do_something()
 
An optional keyword argument 'msg' can be provided when assertRaises
is used as a context object.
 
The context manager keeps a reference to the exception as
the 'exception' attribute. This allows you to inspect the
exception after the assertion::
 
    with self.assertRaises(SomeException) as cm:
        do_something()
    the_exception = cm.exception
    self.assertEqual(the_exception.error_code, 3)
assertRaisesRegex(self, expected_exception, expected_regex, *args, **kwargs)
Asserts that the message in a raised exception matches a regex.
 
Args:
    expected_exception: Exception class expected to be raised.
    expected_regex: Regex (re.Pattern object or string) expected
            to be found in error message.
    args: Function to be called and extra positional args.
    kwargs: Extra kwargs.
    msg: Optional message used in case of failure. Can only be used
            when assertRaisesRegex is used as a context manager.
assertRaisesRegexp = deprecated_func(*args, **kwargs)
assertRegex(self, text, expected_regex, msg=None)
Fail the test unless the text matches the regular expression.
assertRegexpMatches = deprecated_func(*args, **kwargs)
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
 
For the purposes of this function, a valid ordered sequence type is one
which can be indexed, has a length, and has an equality operator.
 
Args:
    seq1: The first sequence to compare.
    seq2: The second sequence to compare.
    seq_type: The expected datatype of the sequences, or None if no
            datatype should be enforced.
    msg: Optional message to use on failure instead of a list of
            differences.
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
 
Args:
    set1: The first set to compare.
    set2: The second set to compare.
    msg: Optional message to use on failure instead of a list of
            differences.
 
assertSetEqual uses ducktyping to support different types of sets, and
is optimized for sets specifically (parameters must support a
difference method).
assertTrue(self, expr, msg=None)
Check that the expression is true.
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
 
Args:
    tuple1: The first tuple to compare.
    tuple2: The second tuple to compare.
    msg: Optional message to use on failure instead of a list of
            differences.
assertWarns(self, expected_warning, *args, **kwargs)
Fail unless a warning of class warnClass is triggered
by the callable when invoked with specified positional and
keyword arguments.  If a different type of warning is
triggered, it will not be handled: depending on the other
warning filtering rules in effect, it might be silenced, printed
out, or raised as an exception.
 
If called with the callable and arguments omitted, will return a
context object used like this::
 
     with self.assertWarns(SomeWarning):
         do_something()
 
An optional keyword argument 'msg' can be provided when assertWarns
is used as a context object.
 
The context manager keeps a reference to the first matching
warning as the 'warning' attribute; similarly, the 'filename'
and 'lineno' attributes give you information about the line
of Python code from which the warning was triggered.
This allows you to inspect the warning after the assertion::
 
    with self.assertWarns(SomeWarning) as cm:
        do_something()
    the_warning = cm.warning
    self.assertEqual(the_warning.some_attribute, 147)
assertWarnsRegex(self, expected_warning, expected_regex, *args, **kwargs)
Asserts that the message in a triggered warning matches a regexp.
Basic functioning is similar to assertWarns() with the addition
that only warnings whose messages also match the regular expression
are considered successful matches.
 
Args:
    expected_warning: Warning class expected to be triggered.
    expected_regex: Regex (re.Pattern object or string) expected
            to be found in error message.
    args: Function to be called and extra positional args.
    kwargs: Extra kwargs.
    msg: Optional message used in case of failure. Can only be used
            when assertWarnsRegex is used as a context manager.
assert_ = deprecated_func(*args, **kwargs)
countTestCases(self)
debug(self)
Run the test without collecting errors in a TestResult
defaultTestResult(self)
doCleanups(self)
Execute all cleanup functions. Normally called for you after
tearDown.
fail(self, msg=None)
Fail immediately, with the given message.
failIf = deprecated_func(*args, **kwargs)
failIfAlmostEqual = deprecated_func(*args, **kwargs)
failIfEqual = deprecated_func(*args, **kwargs)
failUnless = deprecated_func(*args, **kwargs)
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
failUnlessEqual = deprecated_func(*args, **kwargs)
failUnlessRaises = deprecated_func(*args, **kwargs)
id(self)
run(self, result=None)
setUp(self)
Hook method for setting up the test fixture before exercising it.
shortDescription(self)
Returns a one-line description of the test, or None if no
description has been provided.
 
The default implementation of this method returns the first line of
the specified test method's docstring.
skipTest(self, reason)
Skip this test.
subTest(self, msg=<object object>, **params)
Return a context manager that will return the enclosed block
of code in a subtest identified by the optional message and
keyword parameters.  A failure in the subtest marks the test
case as failed but resumes execution at the end of the enclosed
block, allowing further test code to be executed.
tearDown(self)
Hook method for deconstructing the test fixture after testing it.

Class methods inherited from unittest.case.TestCase:
setUpClass() from builtins.type
Hook method for setting up class fixture before running tests in the class.
tearDownClass() from builtins.type
Hook method for deconstructing the class fixture after running all tests in the class.

Data descriptors inherited from unittest.case.TestCase:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from unittest.case.TestCase:
failureException = <class 'AssertionError'>
Assertion failed.
longMessage = True
maxDiff = 640

 
class WalkContext(builtins.object)
    WalkContext(pkg)
 
WalkContext: context structure used by walk_module().
 
  Methods defined here:
__init__(self, pkg)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
build_package_filename(pkgname, pkgvers)
build_package_filename(pkgname, pkgvers) -> str
 
Given a package name and version, return the canonical name of
the file containing it. (This is also used for constructing
package URLs; the filename of a package on a server is the same
as on disk.)
 
This will look like "PACKAGE.VERSION.boop".
 
This is guaranteed to create a distinct pathname for every
(pkgname, vers) pair. This is true even on case-insensitive
filesystems, which is a wrinkle, since version strings are
case-sensitive. We work around this by putting a "^" character
before each capital letter.
construct_zipfile(fl, tup, dirname, contents, metadatafile, resourcesfile=None)
construct_zipfile(fl, (pkgname, pkgvers), dirname, contents,
    metadatafile, resourcesfile=None) -> None
 
Write out a zip file containing the given package data.
The fl must be a ZipFile object, newly opened for writing.
The dirname contains the package data; metadatafile and
resourcesfile must be valid Metadata and Resources files.
(Not Metadata and Resources objects, but rather the files
produced by dump()ing them.)
examine_directory(loader, dirname, destname=None)
examine_directory(loader, dirname, destname=None) ->
    ((pkgname, pkgvers), contents, metadata, resources)
 
Look at a directory containing package data. Figure out its metadata
and resources, considering both the directory contents and the
contents of the Metadata and Resources files (if present).
 
The destname, if provided, may also be used to figure out the
package's desired name and version number.
 
The loader argument must be a PackageLoader. This is used for a test
import, during the process.
 
Any fatal errors will raise ConstructError. This may also print
(non-fatal) warning messages.
 
This returns a tuple of four items:
    - the package name and version: (str, VersionNumber)
    - a list of the files (not subdirs) in the directory; each
        element in the list is a tuple (realname, resourcename),
        where realname is the current absolute path and
        resourcename is the universal relative path in the
        package.
    - a Metadata object.
    - a Resources object.
parse_package_filename(val, assume_1=True)
parse_package_filename(val, assume_1) -> (str, VersionNumber)
 
Given a package filename, return the package name and version that
it should contain. If the filename is not a canonical form, raise
ValueError.
 
The name can look like "PACKAGE.VERSION.boop" or "PACKAGE.boop".
In the latter case, the version returned depends on the assume_1
argument. To get version 1.0, pass True; to get None, pass False.
resolve_argument_list(dirname, key, ag)
resolve_dependency_metadata(dirname, pkgname, pkgvers, resources, metadata, import_record, context)
walk_module(context, mod, prefix='')
walk_module(context, mod, prefix='') -> None
 
Walk through the contents of the given module, and all its submodules.
This looks for Agents.
 
Callers should not pass a prefix argument. That is used for the
recursion.
warning(dirname, msg)
warning(dirname, msg) -> None
 
Print a warning.

 
Data
        version_start_regexp = re.compile('\\.[0-9]')