',
$notice_settings['type'],
$icon,
$heading,
$content,
$button,
$dismissible,
$notice_settings['display']
);
if ( $return ) {
return $notice_template;
}
echo wp_kses( $notice_template, self::get_notice_allowed_html() );
}
/**
* get_plugin_install_url
* @param $plugin_slug
*
* @return string
*/
public static function get_plugin_install_url( $plugin_slug ): string {
$action = 'install-plugin';
return wp_nonce_url(
add_query_arg(
[
'action' => $action,
'plugin' => $plugin_slug,
],
admin_url( 'update.php' )
),
$action . '_' . $plugin_slug
);
}
/**
* get_plugin_activate_url
* @param $plugin_slug
*
* @return string
*/
public static function get_plugin_activate_url( $plugin_slug ): string {
$path = "$plugin_slug/$plugin_slug.php";
return wp_nonce_url(
admin_url( 'plugins.php?action=activate&plugin=' . $path ),
'activate-plugin_' . $path
);
}
/**
* is_dismissed
* @param $key
*
* @return bool
*/
public static function is_dismissed( $key ): bool {
$dismissed = User::get_dismissed_editor_notices();
return in_array( $key, $dismissed, true );
}
/**
* should_display_hint
* @param $hint_key
*
* @return bool
*/
public static function should_display_hint( $hint_key ): bool {
$hint = self::get_hints( $hint_key );
if ( empty( $hint ) ) {
return false;
}
foreach ( $hint as $key => $value ) {
switch ( $key ) {
case self::DISMISSED:
if ( self::is_dismissed( $value ) ) {
return false;
}
break;
case self::CAPABILITY:
if ( ! current_user_can( $value ) ) {
return false;
}
break;
case self::DEFINED:
if ( defined( $value ) ) {
return false;
}
break;
case self::PLUGIN_INSTALLED:
if ( ! self::is_plugin_installed( $value ) ) {
return false;
}
break;
case self::PLUGIN_ACTIVE:
if ( ! self::is_plugin_active( $value ) ) {
return false;
}
break;
}
}
return true;
}
private static function is_conflict_plugin_installed(): bool {
if ( ! Utils::has_pro() ) {
return false;
}
$conflicting_plugins = [
'imagify/imagify.php',
'optimole-wp/optimole-wp.php',
'ewww-image-optimizer/ewww-image-optimizer.php',
'ewww-image-optimizer-cloud/ewww-image-optimizer-cloud.php',
'kraken-image-optimizer/kraken.php',
'shortpixel-image-optimiser/wp-shortpixel.php',
'wp-smushit/wp-smush.php',
'wp-smush-pro/wp-smush.php',
'tiny-compress-images/tiny-compress-images.php',
];
foreach ( $conflicting_plugins as $plugin ) {
if ( self::is_plugin_active( $plugin ) ) {
return true;
}
}
return false;
}
/**
* is_plugin_installed
* @param $plugin
*
* @return bool
*/
public static function is_plugin_installed( $plugin ) : bool {
$plugins = get_plugins();
$plugin = self::ensure_plugin_folder( $plugin );
return ! empty( $plugins[ $plugin ] );
}
/**
* is_plugin_active
* @param $plugin
*
* @return bool
*/
public static function is_plugin_active( $plugin ): bool {
$plugin = self::ensure_plugin_folder( $plugin );
return is_plugin_active( $plugin );
}
/**
* get_plugin_action_url
* @param $plugin
*
* @return string
*/
public static function get_plugin_action_url( $plugin ): string {
if ( ! self::is_plugin_installed( $plugin ) ) {
return self::get_plugin_install_url( $plugin );
}
if ( ! self::is_plugin_active( $plugin ) ) {
return self::get_plugin_activate_url( $plugin );
}
return '';
}
/**
* ensure_plugin_folder
* @param $plugin
*
* @return string
*/
private static function ensure_plugin_folder( $plugin ): string {
if ( false === strpos( $plugin, '/' ) ) {
$plugin = $plugin . '/' . $plugin . '.php';
}
return $plugin;
}
/**
* get_notice_allowed_html
* @return array[]
*/
public static function get_notice_allowed_html(): array {
return [
'div' => [
'class' => [],
'data-display' => [],
],
'svg' => [
'width' => [],
'height' => [],
'viewbox' => [],
'fill' => [],
'xmlns' => [],
],
'path' => [
'd' => [],
'stroke' => [],
'stroke-width' => [],
'stroke-linecap' => [],
'stroke-linejoin' => [],
],
'button' => [
'class' => [],
'data-event' => [],
'data-settings' => [],
'data-tooltip' => [],
],
'i' => [
'class' => [],
'aria-hidden' => [],
],
'span' => [
'class' => [],
],
'a' => [
'href' => [],
'style' => [],
'target' => [],
],
];
}
}
promotions/filtered-promotions-manager.php 0000644 00000004143 14720725675 0015124 0 ustar 00 path_resolver = $path_resolver;
return $this;
}
/**
* Load asset config from a file into the collection.
*
* @param $key
* @param $path
*
* @return $this
*/
public function load( $key, $path = null ) {
if ( ! $path && $this->path_resolver ) {
$path_resolver_callback = $this->path_resolver;
$path = $path_resolver_callback( $key );
}
if ( ! $path || ! file_exists( $path ) ) {
return $this;
}
$config = require $path;
if ( ! $this->is_valid_handle( $config ) ) {
return $this;
}
$this->items[ $key ] = [
'handle' => $config['handle'],
'deps' => $this->is_valid_deps( $config ) ? $config['deps'] : [],
];
return $this;
}
/**
* Check that the handle property in the config is a valid.
*
* @param $config
*
* @return bool
*/
private function is_valid_handle( $config ) {
return ! empty( $config['handle'] ) && is_string( $config['handle'] );
}
/**
* Check that the deps property in the config is a valid.
*
* @param $config
*
* @return bool
*/
private function is_valid_deps( $config ) {
return isset( $config['deps'] ) && is_array( $config['deps'] );
}
}
collection.php 0000644 00000022573 14720725675 0007440 0 ustar 00 items = $items;
}
/**
* @param array $items
*
* @return static
*/
public static function make( array $items = [] ) {
return new static( $items );
}
/**
* @param callable|null $callback
*
* @return $this
*/
public function filter( callable $callback = null ) {
if ( ! $callback ) {
return new static( array_filter( $this->items ) );
}
return new static( array_filter( $this->items, $callback, ARRAY_FILTER_USE_BOTH ) );
}
/**
* @param $items
*
* @return $this
*/
public function merge( $items ) {
if ( $items instanceof Collection ) {
$items = $items->all();
}
return new static( array_merge( $this->items, $items ) );
}
/**
* Union the collection with the given items.
*
* @param array $items
*
* @return $this
*/
public function union( array $items ) {
return new static( $this->all() + $items );
}
/**
* Merge array recursively
*
* @param $items
*
* @return $this
*/
public function merge_recursive( $items ) {
if ( $items instanceof Collection ) {
$items = $items->all();
}
return new static( array_merge_recursive( $this->items, $items ) );
}
/**
* Replace array recursively
*
* @param $items
*
* @return $this
*/
public function replace_recursive( $items ) {
if ( $items instanceof Collection ) {
$items = $items->all();
}
return new static( array_replace_recursive( $this->items, $items ) );
}
/**
* Implode the items
*
* @param $glue
*
* @return string
*/
public function implode( $glue ) {
return implode( $glue, $this->items );
}
/**
* Run a map over each of the items.
*
* @param callable $callback
* @return $this
*/
public function map( callable $callback ) {
$keys = array_keys( $this->items );
$items = array_map( $callback, $this->items, $keys );
return new static( array_combine( $keys, $items ) );
}
/**
* Run a callback over each of the items.
*
* @param callable $callback
* @return $this
*/
public function each( callable $callback ) {
foreach ( $this->items as $key => $value ) {
if ( false === $callback( $value, $key ) ) {
break;
}
}
return $this;
}
/**
* @param callable $callback
* @param null $initial
*
* @return mixed|null
*/
public function reduce( callable $callback, $initial = null ) {
$result = $initial;
foreach ( $this->all() as $key => $value ) {
$result = $callback( $result, $value, $key );
}
return $result;
}
/**
* @param callable $callback
*
* @return $this
*/
public function map_with_keys( callable $callback ) {
$result = [];
foreach ( $this->items as $key => $value ) {
$assoc = $callback( $value, $key );
foreach ( $assoc as $map_key => $map_value ) {
$result[ $map_key ] = $map_value;
}
}
return new static( $result );
}
/**
* Get all items except for those with the specified keys.
*
* @param array $keys
*
* @return $this
*/
public function except( array $keys ) {
return $this->filter( function ( $value, $key ) use ( $keys ) {
return ! in_array( $key, $keys, true );
} );
}
/**
* Get the items with the specified keys.
*
* @param array $keys
*
* @return $this
*/
public function only( array $keys ) {
return $this->filter( function ( $value, $key ) use ( $keys ) {
return in_array( $key, $keys, true );
} );
}
/**
* Run over the collection to get specific prop from the collection item.
*
* @param $key
*
* @return $this
*/
public function pluck( $key ) {
$result = [];
foreach ( $this->items as $item ) {
$result[] = $this->get_item_value( $item, $key );
}
return new static( $result );
}
/**
* Group the collection items by specific key in each collection item.
*
* @param $group_by
*
* @return $this
*/
public function group_by( $group_by ) {
$result = [];
foreach ( $this->items as $item ) {
$group_key = $this->get_item_value( $item, $group_by, 0 );
$result[ $group_key ][] = $item;
}
return new static( $result );
}
/**
* Sort keys
*
* @param false $descending
*
* @return $this
*/
public function sort_keys( $descending = false ) {
$items = $this->items;
if ( $descending ) {
krsort( $items );
} else {
ksort( $items );
}
return new static( $items );
}
/**
* Get specific item from the collection.
*
* @param $key
* @param null $default
*
* @return mixed|null
*/
public function get( $key, $default = null ) {
if ( ! array_key_exists( $key, $this->items ) ) {
return $default;
}
return $this->items[ $key ];
}
/**
* Get the first item.
*
* @param null $default
*
* @return mixed|null
*/
public function first( $default = null ) {
if ( $this->is_empty() ) {
return $default;
}
foreach ( $this->items as $item ) {
return $item;
}
}
/**
* Find an element from the items.
*
* @param callable $callback
* @param null $default
*
* @return mixed|null
*/
public function find( callable $callback, $default = null ) {
foreach ( $this->all() as $key => $item ) {
if ( $callback( $item, $key ) ) {
return $item;
}
}
return $default;
}
/**
* @param callable|string|int $value
*
* @return bool
*/
public function contains( $value ) {
$callback = $value instanceof \Closure
? $value
: function ( $item ) use ( $value ) {
return $item === $value;
};
foreach ( $this->all() as $key => $item ) {
if ( $callback( $item, $key ) ) {
return true;
}
}
return false;
}
/**
* Make sure all the values inside the array are uniques.
*
* @param null|string|string[] $keys
*
* @return $this
*/
public function unique( $keys = null ) {
if ( ! $keys ) {
return new static(
array_unique( $this->items )
);
}
if ( ! is_array( $keys ) ) {
$keys = [ $keys ];
}
$exists = [];
return $this->filter( function ( $item ) use ( $keys, &$exists ) {
$value = null;
foreach ( $keys as $key ) {
$current_value = $this->get_item_value( $item, $key );
$value .= "{$key}:{$current_value};";
}
// If no value for the specific key return the item.
if ( null === $value ) {
return true;
}
// If value is not exists, add to the exists array and return the item.
if ( ! in_array( $value, $exists, true ) ) {
$exists[] = $value;
return true;
}
return false;
} );
}
/**
* @return array
*/
public function keys() {
return array_keys( $this->items );
}
/**
* @return bool
*/
public function is_empty() {
return empty( $this->items );
}
/**
* @return array
*/
public function all() {
return $this->items;
}
/**
* @return array
*/
public function values() {
return array_values( $this->all() );
}
/**
* Support only one level depth.
*
* @return $this
*/
public function flatten() {
$result = [];
foreach ( $this->all() as $item ) {
$item = $item instanceof Collection ? $item->all() : $item;
if ( ! is_array( $item ) ) {
$result[] = $item;
} else {
$values = array_values( $item );
foreach ( $values as $value ) {
$result[] = $value;
}
}
}
return new static( $result );
}
/**
* @param ...$values
*
* @return $this
*/
public function push( ...$values ) {
foreach ( $values as $value ) {
$this->items[] = $value;
}
return $this;
}
public function prepend( ...$values ) {
$this->items = array_merge( $values, $this->items );
return $this;
}
public function some( callable $callback ) {
foreach ( $this->items as $key => $item ) {
if ( $callback( $item, $key ) ) {
return true;
}
}
return false;
}
/**
* @param mixed $offset
*
* @return bool
*/
#[\ReturnTypeWillChange]
public function offsetExists( $offset ) {
return isset( $this->items[ $offset ] );
}
/**
* @param mixed $offset
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function offsetGet( $offset ) {
return $this->items[ $offset ];
}
/**
* @param mixed $offset
* @param mixed $value
*/
#[\ReturnTypeWillChange]
public function offsetSet( $offset, $value ) {
if ( is_null( $offset ) ) {
$this->items[] = $value;
} else {
$this->items[ $offset ] = $value;
}
}
/**
* @param mixed $offset
*/
#[\ReturnTypeWillChange]
public function offsetUnset( $offset ) {
unset( $this->items[ $offset ] );
}
/**
* @return \ArrayIterator|\Traversable
*/
#[\ReturnTypeWillChange]
public function getIterator() {
return new \ArrayIterator( $this->items );
}
/**
* @return int|void
*/
#[\ReturnTypeWillChange]
public function count() {
return count( $this->items );
}
/**
* @param $item
* @param $key
* @param null $default
*
* @return mixed|null
*/
private function get_item_value( $item, $key, $default = null ) {
$value = $default;
if ( is_object( $item ) && isset( $item->{$key} ) ) {
$value = $item->{$key};
} elseif ( is_array( $item ) && isset( $item[ $key ] ) ) {
$value = $item[ $key ];
}
return $value;
}
}
plugins-manager.php 0000644 00000005532 14720725675 0010372 0 ustar 00 upgrader = $upgrader;
} else {
$skin = new WP_Ajax_Upgrader_Skin();
$this->upgrader = new Plugin_Upgrader( $skin );
}
}
/**
* Install plugin or an array of plugins.
*
* @since 3.6.2
*
* @param string|array $plugins
* @return array [ 'succeeded' => [] , 'failed' => [] ]
*/
public function install( $plugins ) {
$succeeded = [];
$failed = [];
$already_installed_plugins = Plugin::$instance->wp->get_plugins();
if ( ! is_array( $plugins ) ) {
$plugins = [ $plugins ];
}
foreach ( $plugins as $plugin ) {
if ( in_array( $plugin, $already_installed_plugins->keys(), true ) ) {
$succeeded[] = $plugin;
continue;
}
$slug = $this->clean_slug( $plugin );
$api = Plugin::$instance->wp->plugins_api('plugin_information',
[
'slug' => $slug,
'fields' => array(
'short_description' => false,
'sections' => false,
'requires' => false,
'rating' => false,
'ratings' => false,
'downloaded' => false,
'last_updated' => false,
'added' => false,
'tags' => false,
'compatibility' => false,
'homepage' => false,
'donate_link' => false,
),
]
);
if ( ! isset( $api->download_link ) ) {
$failed[] = $plugin;
continue;
}
$installation = $this->upgrader->install( $api->download_link );
if ( $installation ) {
$succeeded[] = $plugin;
} else {
$failed[] = $plugin;
}
}
return [
'succeeded' => $succeeded,
'failed' => $failed,
];
}
/**
* Activate plugin or array off plugins.
*
* @since 3.6.2
*
* @param array|string $plugins
* @return array [ 'succeeded' => [] , 'failed' => [] ]
*/
public function activate( $plugins ) {
$succeeded = [];
$failed = [];
if ( ! is_array( $plugins ) ) {
$plugins = [ $plugins ];
}
foreach ( $plugins as $plugin ) {
if ( Plugin::$instance->wp->is_plugin_active( $plugin ) ) {
$succeeded[] = $plugin;
continue;
}
Plugin::$instance->wp->activate_plugin( $plugin );
if ( Plugin::$instance->wp->is_plugin_active( $plugin ) ) {
$succeeded[] = $plugin;
} else {
$failed[] = $plugin;
}
}
return [
'succeeded' => $succeeded,
'failed' => $failed,
];
}
private function clean_slug( $initial_slug ) {
return explode( '/', $initial_slug )[0];
}
}
version.php 0000644 00000007211 14720725675 0006762 0 ustar 00 major1 = $major1;
$this->major2 = $major2;
$this->patch = $patch;
$this->stage = $stage;
}
/**
* Create Version instance.
*
* @param string $major1
* @param string $major2
* @param string $patch
* @param null $stage
*
* @return static
*/
public static function create( $major1 = '0', $major2 = '0', $patch = '0', $stage = null ) {
return new static( $major1, $major2, $patch, $stage );
}
/**
* Checks if the current version string is valid.
*
* @param $version
*
* @return bool
*/
public static function is_valid_version( $version ) {
return ! ! preg_match( '/^(\d+\.)?(\d+\.)?(\*|\d+)(-.+)?$/', $version );
}
/**
* Creates a Version instance from a string.
*
* @param $version
* @param bool $should_validate
*
* @return static
* @throws \Exception
*/
public static function create_from_string( $version, $should_validate = true ) {
if ( $should_validate && ! static::is_valid_version( $version ) ) {
throw new \Exception( "{$version} is an invalid version." );
}
$parts = explode( '.', $version );
$patch_parts = [];
$major1 = '0';
$major2 = '0';
$patch = '0';
$stage = null;
if ( isset( $parts[0] ) ) {
$major1 = $parts[0];
}
if ( isset( $parts[1] ) ) {
$major2 = $parts[1];
}
if ( isset( $parts[2] ) ) {
$patch_parts = explode( '-', $parts[2] );
$patch = $patch_parts[0];
}
if ( isset( $patch_parts[1] ) ) {
$stage = $patch_parts[1];
}
return static::create( $major1, $major2, $patch, $stage );
}
/**
* Compare the current version instance with another version.
*
* @param $operator
* @param $version
* @param string $part
*
* @return bool
* @throws \Exception
*/
public function compare( $operator, $version, $part = self::PART_STAGE ) {
if ( ! ( $version instanceof Version ) ) {
if ( ! static::is_valid_version( $version ) ) {
$version = '0.0.0';
}
$version = static::create_from_string( $version, false );
}
$current_version = clone $this;
$compare_version = clone $version;
if ( in_array( $part, [ self::PART_PATCH, self::PART_MAJOR_2, self::PART_MAJOR_1 ], true ) ) {
$current_version->stage = null;
$compare_version->stage = null;
}
if ( in_array( $part, [ self::PART_MAJOR_2, self::PART_MAJOR_1 ], true ) ) {
$current_version->patch = '0';
$compare_version->patch = '0';
}
if ( self::PART_MAJOR_1 === $part ) {
$current_version->major2 = '0';
$compare_version->major2 = '0';
}
return version_compare(
$current_version,
$compare_version,
$operator
);
}
/**
* Implode the version and return it as string.
*
* @return string
*/
public function __toString() {
$version = implode( '.', [ $this->major1, $this->major2, $this->patch ] );
if ( $this->stage ) {
$version .= '-' . $this->stage;
}
return $version;
}
}
__init__.py 0000644 00000110001 14722165061 0006652 0 ustar 00 """passlib.utils -- helpers for writing password hashes"""
#=============================================================================
# imports
#=============================================================================
from passlib.utils.compat import JYTHON
# core
from binascii import b2a_base64, a2b_base64, Error as _BinAsciiError
from base64 import b64encode, b64decode
import collections
from codecs import lookup as _lookup_codec
from functools import update_wrapper
import itertools
import inspect
import logging; log = logging.getLogger(__name__)
import math
import os
import sys
import random
import re
if JYTHON: # pragma: no cover -- runtime detection
# Jython 2.5.2 lacks stringprep module -
# see http://bugs.jython.org/issue1758320
try:
import stringprep
except ImportError:
stringprep = None
_stringprep_missing_reason = "not present under Jython"
else:
import stringprep
import time
if stringprep:
import unicodedata
import types
from warnings import warn
# site
# pkg
from passlib.utils.binary import (
# [remove these aliases in 2.0]
BASE64_CHARS, AB64_CHARS, HASH64_CHARS, BCRYPT_CHARS,
Base64Engine, LazyBase64Engine, h64, h64big, bcrypt64,
ab64_encode, ab64_decode, b64s_encode, b64s_decode
)
from passlib.utils.decor import (
# [remove these aliases in 2.0]
deprecated_function,
deprecated_method,
memoized_property,
classproperty,
hybrid_method,
)
from passlib.exc import ExpectedStringError
from passlib.utils.compat import (add_doc, join_bytes, join_byte_values,
join_byte_elems, irange, imap, PY3, u,
join_unicode, unicode, byte_elem_value, nextgetter,
unicode_or_bytes_types,
get_method_function, suppress_cause)
# local
__all__ = [
# constants
'JYTHON',
'sys_bits',
'unix_crypt_schemes',
'rounds_cost_values',
# unicode helpers
'consteq',
'saslprep',
# bytes helpers
"xor_bytes",
"render_bytes",
# encoding helpers
'is_same_codec',
'is_ascii_safe',
'to_bytes',
'to_unicode',
'to_native_str',
# host OS
'has_crypt',
'test_crypt',
'safe_crypt',
'tick',
# randomness
'rng',
'getrandbytes',
'getrandstr',
'generate_password',
# object type / interface tests
'is_crypt_handler',
'is_crypt_context',
'has_rounds_info',
'has_salt_info',
]
#=============================================================================
# constants
#=============================================================================
# bitsize of system architecture (32 or 64)
sys_bits = int(math.log(sys.maxsize if PY3 else sys.maxint, 2) + 1.5)
# list of hashes algs supported by crypt() on at least one OS.
# XXX: move to .registry for passlib 2.0?
unix_crypt_schemes = [
"sha512_crypt", "sha256_crypt",
"sha1_crypt", "bcrypt",
"md5_crypt",
# "bsd_nthash",
"bsdi_crypt", "des_crypt",
]
# list of rounds_cost constants
rounds_cost_values = [ "linear", "log2" ]
# legacy import, will be removed in 1.8
from passlib.exc import MissingBackendError
# internal helpers
_BEMPTY = b''
_UEMPTY = u("")
_USPACE = u(" ")
# maximum password size which passlib will allow; see exc.PasswordSizeError
MAX_PASSWORD_SIZE = int(os.environ.get("PASSLIB_MAX_PASSWORD_SIZE") or 4096)
#=============================================================================
# type helpers
#=============================================================================
class SequenceMixin(object):
"""
helper which lets result object act like a fixed-length sequence.
subclass just needs to provide :meth:`_as_tuple()`.
"""
def _as_tuple(self):
raise NotImplemented("implement in subclass")
def __repr__(self):
return repr(self._as_tuple())
def __getitem__(self, idx):
return self._as_tuple()[idx]
def __iter__(self):
return iter(self._as_tuple())
def __len__(self):
return len(self._as_tuple())
def __eq__(self, other):
return self._as_tuple() == other
def __ne__(self, other):
return not self.__eq__(other)
if PY3:
# getargspec() is deprecated, use this under py3.
# even though it's a lot more awkward to get basic info :|
_VAR_KEYWORD = inspect.Parameter.VAR_KEYWORD
_VAR_ANY_SET = set([_VAR_KEYWORD, inspect.Parameter.VAR_POSITIONAL])
def accepts_keyword(func, key):
"""test if function accepts specified keyword"""
params = inspect.signature(get_method_function(func)).parameters
if not params:
return False
arg = params.get(key)
if arg and arg.kind not in _VAR_ANY_SET:
return True
# XXX: annoying what we have to do to determine if VAR_KWDS in use.
return params[list(params)[-1]].kind == _VAR_KEYWORD
else:
def accepts_keyword(func, key):
"""test if function accepts specified keyword"""
spec = inspect.getargspec(get_method_function(func))
return key in spec.args or spec.keywords is not None
def update_mixin_classes(target, add=None, remove=None, append=False,
before=None, after=None, dryrun=False):
"""
helper to update mixin classes installed in target class.
:param target:
target class whose bases will be modified.
:param add:
class / classes to install into target's base class list.
:param remove:
class / classes to remove from target's base class list.
:param append:
by default, prepends mixins to front of list.
if True, appends to end of list instead.
:param after:
optionally make sure all mixins are inserted after
this class / classes.
:param before:
optionally make sure all mixins are inserted before
this class / classes.
:param dryrun:
optionally perform all calculations / raise errors,
but don't actually modify the class.
"""
if isinstance(add, type):
add = [add]
bases = list(target.__bases__)
# strip out requested mixins
if remove:
if isinstance(remove, type):
remove = [remove]
for mixin in remove:
if add and mixin in add:
continue
if mixin in bases:
bases.remove(mixin)
# add requested mixins
if add:
for mixin in add:
# if mixin already present (explicitly or not), leave alone
if any(issubclass(base, mixin) for base in bases):
continue
# determine insertion point
if append:
for idx, base in enumerate(bases):
if issubclass(mixin, base):
# don't insert mixin after one of it's own bases
break
if before and issubclass(base, before):
# don't insert mixin after any classes.
break
else:
# append to end
idx = len(bases)
elif after:
for end_idx, base in enumerate(reversed(bases)):
if issubclass(base, after):
# don't insert mixin before any classes.
idx = len(bases) - end_idx
assert bases[idx-1] == base
break
else:
idx = 0
else:
# insert at start
idx = 0
# insert mixin
bases.insert(idx, mixin)
# modify class
if not dryrun:
target.__bases__ = tuple(bases)
#=============================================================================
# collection helpers
#=============================================================================
def batch(source, size):
"""
split iterable into chunks of elements.
"""
if size < 1:
raise ValueError("size must be positive integer")
if isinstance(source, collections.Sequence):
end = len(source)
i = 0
while i < end:
n = i + size
yield source[i:n]
i = n
elif isinstance(source, collections.Iterable):
itr = iter(source)
while True:
chunk_itr = itertools.islice(itr, size)
try:
first = next(chunk_itr)
except StopIteration:
break
yield itertools.chain((first,), chunk_itr)
else:
raise TypeError("source must be iterable")
#=============================================================================
# unicode helpers
#=============================================================================
# XXX: should this be moved to passlib.crypto, or compat backports?
def consteq(left, right):
"""Check two strings/bytes for equality.
This function uses an approach designed to prevent
timing analysis, making it appropriate for cryptography.
a and b must both be of the same type: either str (ASCII only),
or any type that supports the buffer protocol (e.g. bytes).
Note: If a and b are of different lengths, or if an error occurs,
a timing attack could theoretically reveal information about the
types and lengths of a and b--but not their values.
"""
# NOTE:
# resources & discussions considered in the design of this function:
# hmac timing attack --
# http://rdist.root.org/2009/05/28/timing-attack-in-google-keyczar-library/
# python developer discussion surrounding similar function --
# http://bugs.python.org/issue15061
# http://bugs.python.org/issue14955
# validate types
if isinstance(left, unicode):
if not isinstance(right, unicode):
raise TypeError("inputs must be both unicode or both bytes")
is_py3_bytes = False
elif isinstance(left, bytes):
if not isinstance(right, bytes):
raise TypeError("inputs must be both unicode or both bytes")
is_py3_bytes = PY3
else:
raise TypeError("inputs must be both unicode or both bytes")
# do size comparison.
# NOTE: the double-if construction below is done deliberately, to ensure
# the same number of operations (including branches) is performed regardless
# of whether left & right are the same size.
same_size = (len(left) == len(right))
if same_size:
# if sizes are the same, setup loop to perform actual check of contents.
tmp = left
result = 0
if not same_size:
# if sizes aren't the same, set 'result' so equality will fail regardless
# of contents. then, to ensure we do exactly 'len(right)' iterations
# of the loop, just compare 'right' against itself.
tmp = right
result = 1
# run constant-time string comparision
# TODO: use izip instead (but first verify it's faster than zip for this case)
if is_py3_bytes:
for l,r in zip(tmp, right):
result |= l ^ r
else:
for l,r in zip(tmp, right):
result |= ord(l) ^ ord(r)
return result == 0
# keep copy of this around since stdlib's version throws error on non-ascii chars in unicode strings.
# our version does, but suffers from some underlying VM issues. but something is better than
# nothing for plaintext hashes, which need this. everything else should use consteq(),
# since the stdlib one is going to be as good / better in the general case.
str_consteq = consteq
try:
# for py3.3 and up, use the stdlib version
from hmac import compare_digest as consteq
except ImportError:
pass
# TODO: could check for cryptography package's version,
# but only operates on bytes, so would need a wrapper,
# or separate consteq() into a unicode & a bytes variant.
# from cryptography.hazmat.primitives.constant_time import bytes_eq as consteq
def splitcomma(source, sep=","):
"""split comma-separated string into list of elements,
stripping whitespace.
"""
source = source.strip()
if source.endswith(sep):
source = source[:-1]
if not source:
return []
return [ elem.strip() for elem in source.split(sep) ]
def saslprep(source, param="value"):
"""Normalizes unicode strings using SASLPrep stringprep profile.
The SASLPrep profile is defined in :rfc:`4013`.
It provides a uniform scheme for normalizing unicode usernames
and passwords before performing byte-value sensitive operations
such as hashing. Among other things, it normalizes diacritic
representations, removes non-printing characters, and forbids
invalid characters such as ``\\n``. Properly internationalized
applications should run user passwords through this function
before hashing.
:arg source:
unicode string to normalize & validate
:param param:
Optional noun identifying source parameter in error messages
(Defaults to the string ``"value"``). This is mainly useful to make the caller's error
messages make more sense contextually.
:raises ValueError:
if any characters forbidden by the SASLPrep profile are encountered.
:raises TypeError:
if input is not :class:`!unicode`
:returns:
normalized unicode string
.. note::
This function is not available under Jython,
as the Jython stdlib is missing the :mod:`!stringprep` module
(`Jython issue 1758320 `_).
.. versionadded:: 1.6
"""
# saslprep - http://tools.ietf.org/html/rfc4013
# stringprep - http://tools.ietf.org/html/rfc3454
# http://docs.python.org/library/stringprep.html
# validate type
# XXX: support bytes (e.g. run through want_unicode)?
# might be easier to just integrate this into cryptcontext.
if not isinstance(source, unicode):
raise TypeError("input must be unicode string, not %s" %
(type(source),))
# mapping stage
# - map non-ascii spaces to U+0020 (stringprep C.1.2)
# - strip 'commonly mapped to nothing' chars (stringprep B.1)
in_table_c12 = stringprep.in_table_c12
in_table_b1 = stringprep.in_table_b1
data = join_unicode(
_USPACE if in_table_c12(c) else c
for c in source
if not in_table_b1(c)
)
# normalize to KC form
data = unicodedata.normalize('NFKC', data)
if not data:
return _UEMPTY
# check for invalid bi-directional strings.
# stringprep requires the following:
# - chars in C.8 must be prohibited.
# - if any R/AL chars in string:
# - no L chars allowed in string
# - first and last must be R/AL chars
# this checks if start/end are R/AL chars. if so, prohibited loop
# will forbid all L chars. if not, prohibited loop will forbid all
# R/AL chars instead. in both cases, prohibited loop takes care of C.8.
is_ral_char = stringprep.in_table_d1
if is_ral_char(data[0]):
if not is_ral_char(data[-1]):
raise ValueError("malformed bidi sequence in " + param)
# forbid L chars within R/AL sequence.
is_forbidden_bidi_char = stringprep.in_table_d2
else:
# forbid R/AL chars if start not setup correctly; L chars allowed.
is_forbidden_bidi_char = is_ral_char
# check for prohibited output - stringprep tables A.1, B.1, C.1.2, C.2 - C.9
in_table_a1 = stringprep.in_table_a1
in_table_c21_c22 = stringprep.in_table_c21_c22
in_table_c3 = stringprep.in_table_c3
in_table_c4 = stringprep.in_table_c4
in_table_c5 = stringprep.in_table_c5
in_table_c6 = stringprep.in_table_c6
in_table_c7 = stringprep.in_table_c7
in_table_c8 = stringprep.in_table_c8
in_table_c9 = stringprep.in_table_c9
for c in data:
# check for chars mapping stage should have removed
assert not in_table_b1(c), "failed to strip B.1 in mapping stage"
assert not in_table_c12(c), "failed to replace C.1.2 in mapping stage"
# check for forbidden chars
if in_table_a1(c):
raise ValueError("unassigned code points forbidden in " + param)
if in_table_c21_c22(c):
raise ValueError("control characters forbidden in " + param)
if in_table_c3(c):
raise ValueError("private use characters forbidden in " + param)
if in_table_c4(c):
raise ValueError("non-char code points forbidden in " + param)
if in_table_c5(c):
raise ValueError("surrogate codes forbidden in " + param)
if in_table_c6(c):
raise ValueError("non-plaintext chars forbidden in " + param)
if in_table_c7(c):
# XXX: should these have been caught by normalize?
# if so, should change this to an assert
raise ValueError("non-canonical chars forbidden in " + param)
if in_table_c8(c):
raise ValueError("display-modifying / deprecated chars "
"forbidden in" + param)
if in_table_c9(c):
raise ValueError("tagged characters forbidden in " + param)
# do bidi constraint check chosen by bidi init, above
if is_forbidden_bidi_char(c):
raise ValueError("forbidden bidi character in " + param)
return data
# replace saslprep() with stub when stringprep is missing
if stringprep is None: # pragma: no cover -- runtime detection
def saslprep(source, param="value"):
"""stub for saslprep()"""
raise NotImplementedError("saslprep() support requires the 'stringprep' "
"module, which is " + _stringprep_missing_reason)
#=============================================================================
# bytes helpers
#=============================================================================
def render_bytes(source, *args):
"""Peform ``%`` formating using bytes in a uniform manner across Python 2/3.
This function is motivated by the fact that
:class:`bytes` instances do not support ``%`` or ``{}`` formatting under Python 3.
This function is an attempt to provide a replacement:
it converts everything to unicode (decoding bytes instances as ``latin-1``),
performs the required formatting, then encodes the result to ``latin-1``.
Calling ``render_bytes(source, *args)`` should function roughly the same as
``source % args`` under Python 2.
"""
if isinstance(source, bytes):
source = source.decode("latin-1")
result = source % tuple(arg.decode("latin-1") if isinstance(arg, bytes)
else arg for arg in args)
return result.encode("latin-1")
if PY3:
# new in py32
def bytes_to_int(value):
return int.from_bytes(value, 'big')
def int_to_bytes(value, count):
return value.to_bytes(count, 'big')
else:
# XXX: can any of these be sped up?
from binascii import hexlify, unhexlify
def bytes_to_int(value):
return int(hexlify(value),16)
def int_to_bytes(value, count):
return unhexlify(('%%0%dx' % (count<<1)) % value)
add_doc(bytes_to_int, "decode byte string as single big-endian integer")
add_doc(int_to_bytes, "encode integer as single big-endian byte string")
def xor_bytes(left, right):
"""Perform bitwise-xor of two byte strings (must be same size)"""
return int_to_bytes(bytes_to_int(left) ^ bytes_to_int(right), len(left))
def repeat_string(source, size):
"""repeat or truncate string, so it has length """
cur = len(source)
if size > cur:
mult = (size+cur-1)//cur
return (source*mult)[:size]
else:
return source[:size]
_BNULL = b"\x00"
_UNULL = u("\x00")
def right_pad_string(source, size, pad=None):
"""right-pad or truncate string, so it has length """
cur = len(source)
if size > cur:
if pad is None:
pad = _UNULL if isinstance(source, unicode) else _BNULL
return source+pad*(size-cur)
else:
return source[:size]
#=============================================================================
# encoding helpers
#=============================================================================
_ASCII_TEST_BYTES = b"\x00\n aA:#!\x7f"
_ASCII_TEST_UNICODE = _ASCII_TEST_BYTES.decode("ascii")
def is_ascii_codec(codec):
"""Test if codec is compatible with 7-bit ascii (e.g. latin-1, utf-8; but not utf-16)"""
return _ASCII_TEST_UNICODE.encode(codec) == _ASCII_TEST_BYTES
def is_same_codec(left, right):
"""Check if two codec names are aliases for same codec"""
if left == right:
return True
if not (left and right):
return False
return _lookup_codec(left).name == _lookup_codec(right).name
_B80 = b'\x80'[0]
_U80 = u('\x80')
def is_ascii_safe(source):
"""Check if string (bytes or unicode) contains only 7-bit ascii"""
r = _B80 if isinstance(source, bytes) else _U80
return all(c < r for c in source)
def to_bytes(source, encoding="utf-8", param="value", source_encoding=None):
"""Helper to normalize input to bytes.
:arg source:
Source bytes/unicode to process.
:arg encoding:
Target encoding (defaults to ``"utf-8"``).
:param param:
Optional name of variable/noun to reference when raising errors
:param source_encoding:
If this is specified, and the source is bytes,
the source will be transcoded from *source_encoding* to *encoding*
(via unicode).
:raises TypeError: if source is not unicode or bytes.
:returns:
* unicode strings will be encoded using *encoding*, and returned.
* if *source_encoding* is not specified, byte strings will be
returned unchanged.
* if *source_encoding* is specified, byte strings will be transcoded
to *encoding*.
"""
assert encoding
if isinstance(source, bytes):
if source_encoding and not is_same_codec(source_encoding, encoding):
return source.decode(source_encoding).encode(encoding)
else:
return source
elif isinstance(source, unicode):
return source.encode(encoding)
else:
raise ExpectedStringError(source, param)
def to_unicode(source, encoding="utf-8", param="value"):
"""Helper to normalize input to unicode.
:arg source:
source bytes/unicode to process.
:arg encoding:
encoding to use when decoding bytes instances.
:param param:
optional name of variable/noun to reference when raising errors.
:raises TypeError: if source is not unicode or bytes.
:returns:
* returns unicode strings unchanged.
* returns bytes strings decoded using *encoding*
"""
assert encoding
if isinstance(source, unicode):
return source
elif isinstance(source, bytes):
return source.decode(encoding)
else:
raise ExpectedStringError(source, param)
if PY3:
def to_native_str(source, encoding="utf-8", param="value"):
if isinstance(source, bytes):
return source.decode(encoding)
elif isinstance(source, unicode):
return source
else:
raise ExpectedStringError(source, param)
else:
def to_native_str(source, encoding="utf-8", param="value"):
if isinstance(source, bytes):
return source
elif isinstance(source, unicode):
return source.encode(encoding)
else:
raise ExpectedStringError(source, param)
add_doc(to_native_str,
"""Take in unicode or bytes, return native string.
Python 2: encodes unicode using specified encoding, leaves bytes alone.
Python 3: leaves unicode alone, decodes bytes using specified encoding.
:raises TypeError: if source is not unicode or bytes.
:arg source:
source unicode or bytes string.
:arg encoding:
encoding to use when encoding unicode or decoding bytes.
this defaults to ``"utf-8"``.
:param param:
optional name of variable/noun to reference when raising errors.
:returns: :class:`str` instance
""")
@deprecated_function(deprecated="1.6", removed="1.7")
def to_hash_str(source, encoding="ascii"): # pragma: no cover -- deprecated & unused
"""deprecated, use to_native_str() instead"""
return to_native_str(source, encoding, param="hash")
_true_set = set("true t yes y on 1 enable enabled".split())
_false_set = set("false f no n off 0 disable disabled".split())
_none_set = set(["", "none"])
def as_bool(value, none=None, param="boolean"):
"""
helper to convert value to boolean.
recognizes strings such as "true", "false"
"""
assert none in [True, False, None]
if isinstance(value, unicode_or_bytes_types):
clean = value.lower().strip()
if clean in _true_set:
return True
if clean in _false_set:
return False
if clean in _none_set:
return none
raise ValueError("unrecognized %s value: %r" % (param, value))
elif isinstance(value, bool):
return value
elif value is None:
return none
else:
return bool(value)
#=============================================================================
# host OS helpers
#=============================================================================
try:
from crypt import crypt as _crypt
except ImportError: # pragma: no cover
_crypt = None
has_crypt = False
def safe_crypt(secret, hash):
return None
else:
has_crypt = True
_NULL = '\x00'
# some crypt() variants will return various constant strings when
# an invalid/unrecognized config string is passed in; instead of
# returning NULL / None. examples include ":", ":0", "*0", etc.
# safe_crypt() returns None for any string starting with one of the
# chars in this string...
_invalid_prefixes = u("*:!")
if PY3:
def safe_crypt(secret, hash):
if isinstance(secret, bytes):
# Python 3's crypt() only accepts unicode, which is then
# encoding using utf-8 before passing to the C-level crypt().
# so we have to decode the secret.
orig = secret
try:
secret = secret.decode("utf-8")
except UnicodeDecodeError:
return None
assert secret.encode("utf-8") == orig, \
"utf-8 spec says this can't happen!"
if _NULL in secret:
raise ValueError("null character in secret")
if isinstance(hash, bytes):
hash = hash.decode("ascii")
result = _crypt(secret, hash)
if not result or result[0] in _invalid_prefixes:
return None
return result
else:
def safe_crypt(secret, hash):
if isinstance(secret, unicode):
secret = secret.encode("utf-8")
if _NULL in secret:
raise ValueError("null character in secret")
if isinstance(hash, unicode):
hash = hash.encode("ascii")
result = _crypt(secret, hash)
if not result:
return None
result = result.decode("ascii")
if result[0] in _invalid_prefixes:
return None
return result
add_doc(safe_crypt, """Wrapper around stdlib's crypt.
This is a wrapper around stdlib's :func:`!crypt.crypt`, which attempts
to provide uniform behavior across Python 2 and 3.
:arg secret:
password, as bytes or unicode (unicode will be encoded as ``utf-8``).
:arg hash:
hash or config string, as ascii bytes or unicode.
:returns:
resulting hash as ascii unicode; or ``None`` if the password
couldn't be hashed due to one of the issues:
* :func:`crypt()` not available on platform.
* Under Python 3, if *secret* is specified as bytes,
it must be use ``utf-8`` or it can't be passed
to :func:`crypt()`.
* Some OSes will return ``None`` if they don't recognize
the algorithm being used (though most will simply fall
back to des-crypt).
* Some OSes will return an error string if the input config
is recognized but malformed; current code converts these to ``None``
as well.
""")
def test_crypt(secret, hash):
"""check if :func:`crypt.crypt` supports specific hash
:arg secret: password to test
:arg hash: known hash of password to use as reference
:returns: True or False
"""
assert secret and hash
return safe_crypt(secret, hash) == hash
# pick best timer function to expose as "tick" - lifted from timeit module.
if sys.platform == "win32":
# On Windows, the best timer is time.clock()
from time import clock as timer
else:
# On most other platforms the best timer is time.time()
from time import time as timer
# legacy alias, will be removed in passlib 2.0
tick = timer
def parse_version(source):
"""helper to parse version string"""
m = re.search(r"(\d+(?:\.\d+)+)", source)
if m:
return tuple(int(elem) for elem in m.group(1).split("."))
return None
#=============================================================================
# randomness
#=============================================================================
#------------------------------------------------------------------------
# setup rng for generating salts
#------------------------------------------------------------------------
# NOTE:
# generating salts (e.g. h64_gensalt, below) doesn't require cryptographically
# strong randomness. it just requires enough range of possible outputs
# that making a rainbow table is too costly. so it should be ok to
# fall back on python's builtin mersenne twister prng, as long as it's seeded each time
# this module is imported, using a couple of minor entropy sources.
try:
os.urandom(1)
has_urandom = True
except NotImplementedError: # pragma: no cover
has_urandom = False
def genseed(value=None):
"""generate prng seed value from system resources"""
from hashlib import sha512
if hasattr(value, "getstate") and hasattr(value, "getrandbits"):
# caller passed in RNG as seed value
try:
value = value.getstate()
except NotImplementedError:
# this method throws error for e.g. SystemRandom instances,
# so fall back to extracting 4k of state
value = value.getrandbits(1 << 15)
text = u("%s %s %s %.15f %.15f %s") % (
# if caller specified a seed value, mix it in
value,
# add current process id
# NOTE: not available in some environments, e.g. GAE
os.getpid() if hasattr(os, "getpid") else None,
# id of a freshly created object.
# (at least 1 byte of which should be hard to predict)
id(object()),
# the current time, to whatever precision os uses
time.time(),
time.clock(),
# if urandom available, might as well mix some bytes in.
os.urandom(32).decode("latin-1") if has_urandom else 0,
)
# hash it all up and return it as int/long
return int(sha512(text.encode("utf-8")).hexdigest(), 16)
if has_urandom:
rng = random.SystemRandom()
else: # pragma: no cover -- runtime detection
# NOTE: to reseed use ``rng.seed(genseed(rng))``
# XXX: could reseed on every call
rng = random.Random(genseed())
#------------------------------------------------------------------------
# some rng helpers
#------------------------------------------------------------------------
def getrandbytes(rng, count):
"""return byte-string containing *count* number of randomly generated bytes, using specified rng"""
# NOTE: would be nice if this was present in stdlib Random class
###just in case rng provides this...
##meth = getattr(rng, "getrandbytes", None)
##if meth:
## return meth(count)
if not count:
return _BEMPTY
def helper():
# XXX: break into chunks for large number of bits?
value = rng.getrandbits(count<<3)
i = 0
while i < count:
yield value & 0xff
value >>= 3
i += 1
return join_byte_values(helper())
def getrandstr(rng, charset, count):
"""return string containing *count* number of chars/bytes, whose elements are drawn from specified charset, using specified rng"""
# NOTE: tests determined this is 4x faster than rng.sample(),
# which is why that's not being used here.
# check alphabet & count
if count < 0:
raise ValueError("count must be >= 0")
letters = len(charset)
if letters == 0:
raise ValueError("alphabet must not be empty")
if letters == 1:
return charset * count
# get random value, and write out to buffer
def helper():
# XXX: break into chunks for large number of letters?
value = rng.randrange(0, letters**count)
i = 0
while i < count:
yield charset[value % letters]
value //= letters
i += 1
if isinstance(charset, unicode):
return join_unicode(helper())
else:
return join_byte_elems(helper())
_52charset = '2346789ABCDEFGHJKMNPQRTUVWXYZabcdefghjkmnpqrstuvwxyz'
@deprecated_function(deprecated="1.7", removed="2.0",
replacement="passlib.pwd.genword() / passlib.pwd.genphrase()")
def generate_password(size=10, charset=_52charset):
"""generate random password using given length & charset
:param size:
size of password.
:param charset:
optional string specified set of characters to draw from.
the default charset contains all normal alphanumeric characters,
except for the characters ``1IiLl0OoS5``, which were omitted
due to their visual similarity.
:returns: :class:`!str` containing randomly generated password.
.. note::
Using the default character set, on a OS with :class:`!SystemRandom` support,
this function should generate passwords with 5.7 bits of entropy per character.
"""
return getrandstr(rng, charset, size)
#=============================================================================
# object type / interface tests
#=============================================================================
_handler_attrs = (
"name",
"setting_kwds", "context_kwds",
"verify", "hash", "identify",
)
def is_crypt_handler(obj):
"""check if object follows the :ref:`password-hash-api`"""
# XXX: change to use isinstance(obj, PasswordHash) under py26+?
return all(hasattr(obj, name) for name in _handler_attrs)
_context_attrs = (
"needs_update",
"genconfig", "genhash",
"verify", "encrypt", "identify",
)
def is_crypt_context(obj):
"""check if object appears to be a :class:`~passlib.context.CryptContext` instance"""
# XXX: change to use isinstance(obj, CryptContext)?
return all(hasattr(obj, name) for name in _context_attrs)
##def has_many_backends(handler):
## "check if handler provides multiple baceknds"
## # NOTE: should also provide get_backend(), .has_backend(), and .backends attr
## return hasattr(handler, "set_backend")
def has_rounds_info(handler):
"""check if handler provides the optional :ref:`rounds information ` attributes"""
return ('rounds' in handler.setting_kwds and
getattr(handler, "min_rounds", None) is not None)
def has_salt_info(handler):
"""check if handler provides the optional :ref:`salt information ` attributes"""
return ('salt' in handler.setting_kwds and
getattr(handler, "min_salt_size", None) is not None)
##def has_raw_salt(handler):
## "check if handler takes in encoded salt as unicode (False), or decoded salt as bytes (True)"
## sc = getattr(handler, "salt_chars", None)
## if sc is None:
## return None
## elif isinstance(sc, unicode):
## return False
## elif isinstance(sc, bytes):
## return True
## else:
## raise TypeError("handler.salt_chars must be None/unicode/bytes")
#=============================================================================
# eof
#=============================================================================
hashes.py 0000644 00000005462 14722165061 0006404 0 ustar 00 from __future__ import absolute_import
import hashlib
from pip.exceptions import HashMismatch, HashMissing, InstallationError
from pip.utils import read_chunks
from pip._vendor.six import iteritems, iterkeys, itervalues
# The recommended hash algo of the moment. Change this whenever the state of
# the art changes; it won't hurt backward compatibility.
FAVORITE_HASH = 'sha256'
# Names of hashlib algorithms allowed by the --hash option and ``pip hash``
# Currently, those are the ones at least as collision-resistant as sha256.
STRONG_HASHES = ['sha256', 'sha384', 'sha512']
class Hashes(object):
"""A wrapper that builds multiple hashes at once and checks them against
known-good values
"""
def __init__(self, hashes=None):
"""
:param hashes: A dict of algorithm names pointing to lists of allowed
hex digests
"""
self._allowed = {} if hashes is None else hashes
def check_against_chunks(self, chunks):
"""Check good hashes against ones built from iterable of chunks of
data.
Raise HashMismatch if none match.
"""
gots = {}
for hash_name in iterkeys(self._allowed):
try:
gots[hash_name] = hashlib.new(hash_name)
except (ValueError, TypeError):
raise InstallationError('Unknown hash name: %s' % hash_name)
for chunk in chunks:
for hash in itervalues(gots):
hash.update(chunk)
for hash_name, got in iteritems(gots):
if got.hexdigest() in self._allowed[hash_name]:
return
self._raise(gots)
def _raise(self, gots):
raise HashMismatch(self._allowed, gots)
def check_against_file(self, file):
"""Check good hashes against a file-like object
Raise HashMismatch if none match.
"""
return self.check_against_chunks(read_chunks(file))
def check_against_path(self, path):
with open(path, 'rb') as file:
return self.check_against_file(file)
def __nonzero__(self):
"""Return whether I know any known-good hashes."""
return bool(self._allowed)
def __bool__(self):
return self.__nonzero__()
class MissingHashes(Hashes):
"""A workalike for Hashes used when we're missing a hash for a requirement
It computes the actual hash of the requirement and raises a HashMissing
exception showing it to the user.
"""
def __init__(self):
"""Don't offer the ``hashes`` kwarg."""
# Pass our favorite hash in to generate a "gotten hash". With the
# empty list, it will never match, so an error will always raise.
super(MissingHashes, self).__init__(hashes={FAVORITE_HASH: []})
def _raise(self, gots):
raise HashMissing(gots[FAVORITE_HASH].hexdigest())
outdated.py 0000644 00000013545 14722165061 0006743 0 ustar 00 from __future__ import absolute_import
import datetime
import json
import logging
import os.path
import sys
from pip._vendor import lockfile
from pip._vendor.packaging import version as packaging_version
from pip.compat import total_seconds, WINDOWS
from pip.models import PyPI
from pip.locations import USER_CACHE_DIR, running_under_virtualenv
from pip.utils import ensure_dir, get_installed_version
from pip.utils.filesystem import check_path_owner
SELFCHECK_DATE_FMT = "%Y-%m-%dT%H:%M:%SZ"
logger = logging.getLogger(__name__)
class VirtualenvSelfCheckState(object):
def __init__(self):
self.statefile_path = os.path.join(sys.prefix, "pip-selfcheck.json")
# Load the existing state
try:
with open(self.statefile_path) as statefile:
self.state = json.load(statefile)
except (IOError, ValueError):
self.state = {}
def save(self, pypi_version, current_time):
# Attempt to write out our version check file
with open(self.statefile_path, "w") as statefile:
json.dump(
{
"last_check": current_time.strftime(SELFCHECK_DATE_FMT),
"pypi_version": pypi_version,
},
statefile,
sort_keys=True,
separators=(",", ":")
)
class GlobalSelfCheckState(object):
def __init__(self):
self.statefile_path = os.path.join(USER_CACHE_DIR, "selfcheck.json")
# Load the existing state
try:
with open(self.statefile_path) as statefile:
self.state = json.load(statefile)[sys.prefix]
except (IOError, ValueError, KeyError):
self.state = {}
def save(self, pypi_version, current_time):
# Check to make sure that we own the directory
if not check_path_owner(os.path.dirname(self.statefile_path)):
return
# Now that we've ensured the directory is owned by this user, we'll go
# ahead and make sure that all our directories are created.
ensure_dir(os.path.dirname(self.statefile_path))
# Attempt to write out our version check file
with lockfile.LockFile(self.statefile_path):
if os.path.exists(self.statefile_path):
with open(self.statefile_path) as statefile:
state = json.load(statefile)
else:
state = {}
state[sys.prefix] = {
"last_check": current_time.strftime(SELFCHECK_DATE_FMT),
"pypi_version": pypi_version,
}
with open(self.statefile_path, "w") as statefile:
json.dump(state, statefile, sort_keys=True,
separators=(",", ":"))
def load_selfcheck_statefile():
if running_under_virtualenv():
return VirtualenvSelfCheckState()
else:
return GlobalSelfCheckState()
def pip_installed_by_pip():
"""Checks whether pip was installed by pip
This is used not to display the upgrade message when pip is in fact
installed by system package manager, such as dnf on Fedora.
"""
import pkg_resources
try:
dist = pkg_resources.get_distribution('pip')
return (dist.has_metadata('INSTALLER') and
'pip' in dist.get_metadata_lines('INSTALLER'))
except pkg_resources.DistributionNotFound:
return False
def pip_version_check(session):
"""Check for an update for pip.
Limit the frequency of checks to once per week. State is stored either in
the active virtualenv or in the user's USER_CACHE_DIR keyed off the prefix
of the pip script path.
"""
installed_version = get_installed_version("pip")
if installed_version is None:
return
pip_version = packaging_version.parse(installed_version)
pypi_version = None
try:
state = load_selfcheck_statefile()
current_time = datetime.datetime.utcnow()
# Determine if we need to refresh the state
if "last_check" in state.state and "pypi_version" in state.state:
last_check = datetime.datetime.strptime(
state.state["last_check"],
SELFCHECK_DATE_FMT
)
if total_seconds(current_time - last_check) < 7 * 24 * 60 * 60:
pypi_version = state.state["pypi_version"]
# Refresh the version if we need to or just see if we need to warn
if pypi_version is None:
resp = session.get(
PyPI.pip_json_url,
headers={"Accept": "application/json"},
)
resp.raise_for_status()
pypi_version = [
v for v in sorted(
list(resp.json()["releases"]),
key=packaging_version.parse,
)
if not packaging_version.parse(v).is_prerelease
][-1]
# save that we've performed a check
state.save(pypi_version, current_time)
remote_version = packaging_version.parse(pypi_version)
# Determine if our pypi_version is older
if (pip_version < remote_version and
pip_version.base_version != remote_version.base_version and
pip_installed_by_pip()):
# Advise "python -m pip" on Windows to avoid issues
# with overwriting pip.exe.
if WINDOWS:
pip_cmd = "python -m pip"
else:
pip_cmd = "pip"
logger.warning(
"You are using pip version %s, however version %s is "
"available.\nYou should consider upgrading via the "
"'%s install --upgrade pip' command.",
pip_version, pypi_version, pip_cmd
)
except Exception:
logger.debug(
"There was an error checking the latest version of pip",
exc_info=True,
)
__pycache__/filesystem.cpython-36.opt-1.pyc 0000644 00000001064 14722165061 0014532 0 ustar 00 3
.
g @ s( d dl Z d dlZ d dlmZ dd ZdS ) N) get_path_uidc C s t tdsdS d }xp| |krtjj| rntj dkr^y t| }W n tk
rT dS X |dkS tj| tjS q| tjj | }} qW d S )NgeteuidTr F)
hasattrospathlexistsr r OSErroraccessW_OKdirname)r ZpreviousZpath_uid r /usr/lib/python3.6/filesystem.pycheck_path_owner s
r )r Zos.pathZ
pip.compatr r r r r r
s __pycache__/filesystem.cpython-36.pyc 0000644 00000001064 14722165061 0013573 0 ustar 00 3
.
g @ s( d dl Z d dlZ d dlmZ dd ZdS ) N) get_path_uidc C s t tdsdS d }xp| |krtjj| rntj dkr^y t| }W n tk
rT dS X |dkS tj| tjS q| tjj | }} qW d S )NgeteuidTr F)
hasattrospathlexistsr r OSErroraccessW_OKdirname)r ZpreviousZpath_uid r /usr/lib/python3.6/filesystem.pycheck_path_owner s
r )r Zos.pathZ
pip.compatr r r r r r
s __pycache__/hashes.cpython-36.pyc 0000644 00000006227 14722165061 0012670 0 ustar 00 3
.
g2 @ sz d dl mZ d dlZd dlmZmZmZ d dlmZ d dl m
Z
m Z m Z dZ
dddgZG d d
d
eZG d d d eZdS )
)absolute_importN) HashMismatch HashMissingInstallationError) read_chunks) iteritemsiterkeys
itervaluesZsha256Zsha384Zsha512c @ sJ e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dS )HasheszaA wrapper that builds multiple hashes at once and checks them against
known-good values
Nc C s |dkr i n|| _ dS )zo
:param hashes: A dict of algorithm names pointing to lists of allowed
hex digests
N)_allowed)selfhashes r /usr/lib/python3.6/hashes.py__init__ s zHashes.__init__c
C s i }xJt | jD ]<}ytj|||< W q ttfk
rJ td| Y qX qW x(|D ] }xt|D ]}|j| qdW qVW x*t |D ] \}}|j
| j| krdS qW | j | dS )zCheck good hashes against ones built from iterable of chunks of
data.
Raise HashMismatch if none match.
zUnknown hash name: %sN) r r hashlibnew
ValueError TypeErrorr r updater hexdigest_raise)r ZchunksgotsZ hash_namechunkhashZgotr r r check_against_chunks s
zHashes.check_against_chunksc C s t | j|d S )N)r r )r r r r r r 7 s z
Hashes._raisec C s | j t|S )zaCheck good hashes against a file-like object
Raise HashMismatch if none match.
)r r )r filer r r check_against_file: s zHashes.check_against_filec C s t |d }| j|S Q R X d S )Nrb)openr )r pathr r r r check_against_pathB s zHashes.check_against_pathc C s
t | jS )z,Return whether I know any known-good hashes.)boolr )r r r r __nonzero__F s zHashes.__nonzero__c C s | j S )N)r# )r r r r __bool__J s zHashes.__bool__)N) __name__
__module__ __qualname____doc__r r r r r! r# r$ r r r r r
s
r
c s( e Zd ZdZ fddZdd Z ZS )
MissingHasheszA workalike for Hashes used when we're missing a hash for a requirement
It computes the actual hash of the requirement and raises a HashMissing
exception showing it to the user.
c s t t| jtg id dS )z!Don't offer the ``hashes`` kwarg.)r
N)superr) r
FAVORITE_HASH)r ) __class__r r r U s zMissingHashes.__init__c C s t |t j d S )N)r r+ r )r r r r r r [ s zMissingHashes._raise)r% r& r' r( r r
__classcell__r r )r, r r) N s r) )Z
__future__r r Zpip.exceptionsr r r Z pip.utilsr Zpip._vendor.sixr r r r+ Z
STRONG_HASHESobjectr
r) r r r r s
: __pycache__/appdirs.cpython-36.pyc 0000644 00000017002 14722165061 0013050 0 ustar 00 3
.
gk" @ s d Z ddlmZ ddlZddlZddlmZmZ ddlm Z m
Z
dd Z dd d
Z dd d
Z
dd Zdd Zdd ZeryddlZeZW n ek
r eZY nX dd ZdS )zd
This code was taken from https://github.com/ActiveState/appdirs and modified
to suit our purposes.
)absolute_importN)WINDOWS
expanduser)PY2 text_typec C s t r
Unix: ~/.cache/ (XDG default)
Windows: C:\Users\\AppData\Local\\Cache
On Windows the only suggestion in the MSDN docs is that local settings go
in the `CSIDL_LOCAL_APPDATA` directory. This is identical to the
non-roaming app data dir (the default returned by `user_data_dir`). Apps
typically put cache data somewhere *under* the given dir here. Some
examples:
...\Mozilla\Firefox\Profiles\\Cache
...\Acme\SuperApp\Cache\1.0
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value.
CSIDL_LOCAL_APPDATAZCachedarwinz~/Library/CachesZXDG_CACHE_HOMEz~/.cache)r ospathnormpath_get_win_folderr
isinstancer _win_path_to_bytesjoinsysplatformr getenv)appnamer
r /usr/lib/python3.6/appdirs.pyuser_cache_dir s
r Fc C sh t r,|r dpd}tjjtjjt|| }n8tjdkrJtjjtd| }ntjjtj dtd| }|S )aS
Return full path to the user-specific data dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default False) can be set True to use the Windows
roaming appdata directory. That means that for users on a Windows
network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: ~/Library/Application Support/
Unix: ~/.local/share/ # or in
$XDG_DATA_HOME, if defined
Win XP (not roaming): C:\Documents and Settings\\ ...
...Application Data\
Win XP (roaming): C:\Documents and Settings\\Local ...
...Settings\Application Data\
Win 7 (not roaming): C:\Users\\AppData\Local\
Win 7 (roaming): C:\Users\\AppData\Roaming\
For Unix, we follow the XDG spec and support $XDG_DATA_HOME.
That means, by default "~/.local/share/".
CSIDL_APPDATAr r z ~/Library/Application Support/Z
XDG_DATA_HOMEz~/.local/share)
r r r
r r r r r r r )r roamingconstr
r r r
user_data_dir> s
r Tc C sH t rt| |d}n2tjdkr&t| }n tjdtd}tjj|| }|S )ar Return full path to the user-specific config dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default True) can be set False to not use the
Windows roaming appdata directory. That means that for users on a
Windows network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: same as user_data_dir
Unix: ~/.config/
Win *: same as user_data_dir
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
That means, by default "~/.config/".
)r r ZXDG_CONFIG_HOMEz ~/.config) r r r r r r r r
r )r r r
r r r user_config_dirj s
r c s t r&tjjtd}tjj| g}nVtjdkrBtjjd g}n:tjdd}|rn fdd|j tj
D }ng }|j d |S ) a Return a list of potential user-shared config dirs for this application.
"appname" is the name of application.
Typical user config directories are:
macOS: /Library/Application Support//
Unix: /etc or $XDG_CONFIG_DIRS[i]// for each value in
$XDG_CONFIG_DIRS
Win XP: C:\Documents and Settings\All Users\Application ...
...Data\ Vista: (Fail! "C:\ProgramData" is a hidden *system* directory
on Vista.)
Win 7: Hidden, but writeable on Win 7:
C:\ProgramData\ CSIDL_COMMON_APPDATAr z /Library/Application SupportZXDG_CONFIG_DIRSz/etc/xdgc s g | ]}t jjt| qS r )r r
r r ).0x)r r r
s z$site_config_dirs..z/etc) r r r
r r r r r r splitpathsepappend)r r
ZpathlistZxdg_config_dirsr )r r site_config_dirs s
r# c C s: ddl }dddd| }|j|jd}|j||\}}|S )z
This is a fallback technique at best. I'm not sure if using the
registry for this guarantees us the correct answer for all CSIDL_*
names.
r NZAppDatazCommon AppDataz
Local AppData)r r r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)_winregOpenKeyHKEY_CURRENT_USERZ QueryValueEx)
csidl_namer$ Zshell_folder_namekeyZ directoryZ_typer r r _get_win_folder_from_registry s r) c C s dddd| }t jd}t jjjd |d d| d}x |D ]}t|dkr:d }P q:W |rzt jd}t jjj|j|drz|}|jS )
N # )r r r i r F T) ctypesZcreate_unicode_bufferZwindllZshell32ZSHGetFolderPathWordZkernel32ZGetShortPathNameWvalue)r' Z csidl_constZbufZ
has_high_charcZbuf2r r r _get_win_folder_with_ctypes s
r2 c
C s6 x0dD ](}y
| j |S ttfk
r, Y qX qW | S )a Encode Windows paths to bytes. Only used on Python 2.
Motivation is to be consistent with other operating systems where paths
are also returned as bytes. This avoids problems mixing bytes and Unicode
elsewhere in the codebase. For more details and discussion see
.
If encoding using ASCII and MBCS fails, return the original Unicode path.
ASCIIMBCS)r3 r4 )encodeUnicodeEncodeError LookupError)r
encodingr r r r s
r )F)T)__doc__Z
__future__r r r Z
pip.compatr r Zpip._vendor.sixr r r r r r# r) r2 r. r ImportErrorr r r r r s$ 0
,
!(
__pycache__/outdated.cpython-36.opt-1.pyc 0000644 00000011147 14722165061 0014162 0 ustar 00 3
.
ge @ s d dl mZ d dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z d dl
mZmZ d dlmZ d dlmZmZ d dlmZmZ d d lmZ d
Zeje Z G d d d e Z G d
d de Z dd Z!dd Z"dd Z#dS ) )absolute_importN)lockfile)version)
total_secondsWINDOWS)PyPI)USER_CACHE_DIRrunning_under_virtualenv)
ensure_dirget_installed_version)check_path_ownerz%Y-%m-%dT%H:%M:%SZc @ s e Zd Zdd Zdd ZdS )VirtualenvSelfCheckStatec C s\ t jjtjd| _y&t| j}tj|| _ W d Q R X W n t
t fk
rV i | _ Y nX d S )Nzpip-selfcheck.json) ospathjoinsysprefixstatefile_pathopenjsonloadstateIOError
ValueError)self statefile r /usr/lib/python3.6/outdated.py__init__ s z!VirtualenvSelfCheckState.__init__c
C s: t | jd$}tj|jt|d|ddd W d Q R X d S )Nw)
last_check pypi_versionT,:) sort_keys
separators)r" r# )r r r dumpstrftimeSELFCHECK_DATE_FMT)r r! current_timer r r r save$ s z VirtualenvSelfCheckState.saveN)__name__
__module__ __qualname__r r* r r r r r
s
r
c @ s e Zd Zdd Zdd ZdS )GlobalSelfCheckStatec C sb t jjtd| _y,t| j}tj|tj | _
W d Q R X W n t t t
fk
r\ i | _
Y nX d S )Nzselfcheck.json)r r r r r r r r r r r r r KeyError)r r r r r r 3 s z GlobalSelfCheckState.__init__c C s t tjj| jsd S ttjj| j tj| jz tjj| jrft | j}t
j |}W d Q R X ni }|j t
|d|tj< t | jd}t
j||ddd W d Q R X W d Q R X d S )N)r r! r Tr" r# )r$ r% )r" r# )r r r dirnamer r
r ZLockFileexistsr r r r' r( r r r& )r r! r) r r r r r r* = s
zGlobalSelfCheckState.saveN)r+ r, r- r r* r r r r r. 2 s
r. c C s t r t S t S d S )N)r r
r. r r r r load_selfcheck_statefileX s r2 c C sF ddl } y"| jd}|jdo*d|jdkS | jk
r@ dS X dS )zChecks whether pip was installed by pip
This is used not to display the upgrade message when pip is in fact
installed by system package manager, such as dnf on Fedora.
r NpipZ INSTALLERF)
pkg_resourcesZget_distributionZ has_metadataZget_metadata_linesZDistributionNotFound)r4 Zdistr r r pip_installed_by_pip_ s
r5 c
C sF t d}|dkrdS tj|}d} yt }tjj }d|jkrxd|jkrxtjj|jd t}t || dk rx|jd }|dkr| j
t j dd id
}|j
d d tt|j d
tjdD d }|j|| tj|}||k r|j|jkrt rtrd} nd} tjd||| W n$ tk
r@ tjddd Y nX dS )zCheck for an update for pip.
Limit the frequency of checks to once per week. State is stored either in
the active virtualenv or in the user's USER_CACHE_DIR keyed off the prefix
of the pip script path.
r3 Nr r! < ZAcceptzapplication/json)Zheadersc S s g | ]}t j|js|qS r )packaging_versionparseZ
is_prerelease).0vr r r
s z%pip_version_check..Zreleases)key z
python -m pipzYou are using pip version %s, however version %s is available.
You should consider upgrading via the '%s install --upgrade pip' command.z5There was an error checking the latest version of pipT)exc_info i`' i: )r r9 r: r2 datetimeZutcnowr Zstrptimer( r getr Z pip_json_urlZraise_for_statussortedlistr r* Z base_versionr5 r loggerZwarning Exceptiondebug)
ZsessionZinstalled_versionZ pip_versionr! r r) r ZrespZremote_versionZpip_cmdr r r pip_version_checkn sL
rJ )$Z
__future__r rC r ZloggingZos.pathr r Z pip._vendorr Zpip._vendor.packagingr r9 Z
pip.compatr r Z
pip.modelsr Z
pip.locationsr r Z pip.utilsr
r Zpip.utils.filesystemr r( Z getLoggerr+ rG objectr
r. r2 r5 rJ r r r r s&
& __pycache__/packaging.cpython-36.opt-1.pyc 0000644 00000003657 14722165061 0014304 0 ustar 00 3
.
g @ s~ d dl mZ d dlmZ d dlZd dlZd dlmZ d dlmZ d dl m
Z
d dl m Z ej
eZdd Zd
d Zd d
ZdS ) )absolute_import)
FeedParserN)
specifiers)version)
pkg_resources)
exceptionsc C s> | dkr dS t j| }tjdjtttjdd }||kS )aG
Check if the python version in use match the `requires_python` specifier.
Returns `True` if the version of python in use matches the requirement.
Returns `False` if the version of python in use does not matches the
requirement.
Raises an InvalidSpecifier if `requires_python` have an invalid format.
NT. ) r Z SpecifierSetr parsejoinmapstrsys version_info)requires_pythonZrequires_python_specifierZpython_version r /usr/lib/python3.6/packaging.pycheck_requires_python s
r c C s8 t | tjr | jdr | jdS | jdr4| jdS d S )NZMETADATAzPKG-INFO)
isinstancer ZDistInfoDistributionZ has_metadata get_metadata)distr r r r % s
r c C s t | }t }|j| |j }|jd}y8t|s`tjd| j|dj t
t t j
d d f W n8 tjk
r } ztjd| j||f d S d }~X nX d S )NzRequires-Pythonz4%s requires Python '%s' but the running Python is %sr r z7Package %s has an invalid Requires-Python entry %s - %s)r r Zfeedclosegetr r ZUnsupportedPythonVersionZ project_namer r r
r r r ZInvalidSpecifierloggerZwarning)r ZmetadataZ feed_parserZ
pkg_info_dictr er r r check_dist_requires_python- s"
$r )Z
__future__r Z email.parserr Zloggingr Zpip._vendor.packagingr r Z pip._vendorr Zpipr Z getLogger__name__r r r r r r r r s
__pycache__/glibc.cpython-36.opt-1.pyc 0000644 00000002503 14722165061 0013425 0 ustar 00 3
.
g{ @ sP d dl mZ d dlZd dlZd dlZd dlZdd Zdd Zdd Zd d
Z dS ) )absolute_importNc C sP t jd} y
| j}W n tk
r( dS X t j|_| }t|tsL|jd}|S )z9Returns glibc version string, or None if not using glibc.Nascii) ctypesZCDLLgnu_get_libc_versionAttributeErrorZc_char_pZrestype
isinstancestrdecode)Zprocess_namespacer version_str r /usr/lib/python3.6/glibc.pyglibc_version_string s
r
c C sH t jd| }|s$tjd| t dS t|jd|koFt|jd|kS )Nz$(?P[0-9]+)\.(?P[0-9]+)z=Expected glibc version with 2 components major.minor, got: %sFmajorminor)rematchwarningswarnRuntimeWarningintgroup)r
required_major
minimum_minormr r r check_glibc_version# s
r c C s t }|d krdS t|| |S )NF)r
r )r r r
r r r have_compatible_glibc3 s r c C s" t } | d krtj S d| fS d S )NZglibc)r
platformlibc_ver)Z
glibc_versionr r r r K s r )
Z
__future__r r r r r r
r r r r r r r s __pycache__/deprecation.cpython-36.opt-1.pyc 0000644 00000003255 14722165061 0014647 0 ustar 00 3
.
g @ s d Z ddlmZ ddlZddlZG dd deZG dd deZG dd d eZ G d
d d eeZ
G d d
d
eZ da dddZ
dd ZdS )zN
A module that implements tooling to enable easy warnings about deprecations.
)absolute_importNc @ s e Zd ZdS )PipDeprecationWarningN)__name__
__module__ __qualname__ r r !/usr/lib/python3.6/deprecation.pyr
s r c @ s e Zd ZdS )PendingN)r r r r r r r r s r c @ s e Zd ZdS )RemovedInPip10WarningN)r r r r r r r r
s r
c @ s e Zd ZdS )RemovedInPip11WarningN)r r r r r r r r s r c @ s e Zd ZdS )Python26DeprecationWarningN)r r r r r r r r s r c C sx |d k r$t d k rtt | ||||| nPt|trbtjd}d| }t|trV|j| qt|j| nt | ||||| d S )Nzpip.deprecationszDEPRECATION: %s)_warnings_showwarning
issubclassr loggingZ getLoggerr Zwarningerror)messagecategoryfilenamelinenofilelineZloggerZ log_messager r r _showwarning$ s
r c C s( t jdtdd td kr$t jatt _d S )NdefaultT)append)warnings simplefilterr r
showwarningr r r r r install_warning_loggerD s r )NN)__doc__Z
__future__r r r Warningr objectr r
r r r
r r r r r r s
__pycache__/packaging.cpython-36.pyc 0000644 00000003657 14722165061 0013345 0 ustar 00 3
.
g @ s~ d dl mZ d dlmZ d dlZd dlZd dlmZ d dlmZ d dl m
Z
d dl m Z ej
eZdd Zd
d Zd d
ZdS ) )absolute_import)
FeedParserN)
specifiers)version)
pkg_resources)
exceptionsc C s> | dkr dS t j| }tjdjtttjdd }||kS )aG
Check if the python version in use match the `requires_python` specifier.
Returns `True` if the version of python in use matches the requirement.
Returns `False` if the version of python in use does not matches the
requirement.
Raises an InvalidSpecifier if `requires_python` have an invalid format.
NT. ) r Z SpecifierSetr parsejoinmapstrsys version_info)requires_pythonZrequires_python_specifierZpython_version r /usr/lib/python3.6/packaging.pycheck_requires_python s
r c C s8 t | tjr | jdr | jdS | jdr4| jdS d S )NZMETADATAzPKG-INFO)
isinstancer ZDistInfoDistributionZ has_metadata get_metadata)distr r r r % s
r c C s t | }t }|j| |j }|jd}y8t|s`tjd| j|dj t
t t j
d d f W n8 tjk
r } ztjd| j||f d S d }~X nX d S )NzRequires-Pythonz4%s requires Python '%s' but the running Python is %sr r z7Package %s has an invalid Requires-Python entry %s - %s)r r Zfeedclosegetr r ZUnsupportedPythonVersionZ project_namer r r
r r r ZInvalidSpecifierloggerZwarning)r ZmetadataZ feed_parserZ
pkg_info_dictr er r r check_dist_requires_python- s"
$r )Z
__future__r Z email.parserr Zloggingr Zpip._vendor.packagingr r Z pip._vendorr Zpipr Z getLogger__name__r r r r r r r r s
__pycache__/build.cpython-36.opt-1.pyc 0000644 00000002420 14722165061 0013442 0 ustar 00 3
.
g @ s< d dl mZ d dlZd dlZd dlmZ G dd deZdS ) )absolute_importN)rmtreec @ s6 e Zd Zd ddZdd Zdd Zdd Zd
d ZdS )
BuildDirectoryNc C sL |d kr|d krd}|d kr)format __class____name__r
)r r
r
r __repr__ s zBuildDirectory.__repr__c C s | j S )N)r
)r r
r
r __enter__" s zBuildDirectory.__enter__c C s | j d S )N)cleanup)r excvaluetbr
r
r __exit__% s zBuildDirectory.__exit__c C s | j rt| j d S )N)r r r
)r r
r
r r ( s zBuildDirectory.cleanup)NN)r
__module__ __qualname__r r r r r r
r
r
r r s
r ) Z
__future__r Zos.pathr r Z pip.utilsr objectr r
r
r
r s __pycache__/ui.cpython-36.opt-1.pyc 0000644 00000022441 14722165061 0012765 0 ustar 00 3
.
gM- @ s d dl mZ d dl mZ d dlZd dlZd dlmZmZmZ d dlZd dl Z d dl
Z
d dl m Z d dl
mZ d dlmZ d dlmZ d d lmZmZ d d
lmZmZmZ d d lmZ yd d lm Z W n e k
r dZ Y nX e
j e Z d
d Z!e!eeZ"G dd de#Z$G dd de#Z%G dd de#Z&G dd de&e$e%e"Z'G dd de&e$e%eeZ(e j)dd Z*G dd d e#Z+G d d d e#Z,G d d d e#Z-e j)d!d" Z.dS )# )absolute_import)divisionN)signalSIGINTdefault_int_handler)WINDOWS) format_size)get_indentation)six)BarIncrementalBar) WritelnMixin HIDE_CURSOR SHOW_CURSOR)Spinner)coloramac C s t | jdd }|s|S t | dtj t | dtj g}|tt | dg 7 }ytj j|j| W n tk
rv |S X | S d S )NencodingZ
empty_fillZfillphases)getattrfiler
Z text_typelistjoinencodeUnicodeEncodeError)Z preferredZfallbackr Z
characters r /usr/lib/python3.6/ui.py_select_progress_class s r c s4 e Zd ZdZ fddZ fddZdd Z ZS )InterruptibleMixina
Helper to ensure that self.finish() gets called on keyboard interrupt.
This allows downloads to be interrupted without leaving temporary state
(like hidden cursors) behind.
This class is similar to the progress library's existing SigIntMixin
helper, but as of version 1.2, that helper has the following problems:
1. It calls sys.exit().
2. It discards the existing SIGINT handler completely.
3. It leaves its own handler in place even after an uninterrupted finish,
which will have unexpected delayed effects if the user triggers an
unrelated keyboard interrupt some time after a progress-displaying
download has already completed, for example.
c s4 t t| j|| tt| j| _| jdkr0t| _dS )z=
Save the original SIGINT handler for later.
N)superr __init__r r
handle_sigintoriginal_handlerr )selfargskwargs) __class__r r r N s
zInterruptibleMixin.__init__c s t t| j tt| j dS )z
Restore the original SIGINT handler after finishing.
This should happen regardless of whether the progress display finishes
normally, or gets interrupted.
N)r r finishr r r! )r" )r% r r r& ^ s zInterruptibleMixin.finishc C s | j | j|| dS )z
Call self.finish() before delegating to the original SIGINT handler.
This handler should only be in place while the progress display is
active.
N)r& r! )r" Zsignumframer r r r h s z InterruptibleMixin.handle_sigint)__name__
__module__ __qualname____doc__r r& r
__classcell__r r )r% r r < s
r c sJ e Zd Z fddZedd Zedd Zedd Zd d
d Z Z S )
DownloadProgressMixinc s, t t| j|| dt d | j | _d S )N )r r- r r message)r" r# r$ )r% r r r u s z DownloadProgressMixin.__init__c C s
t | jS )N)r index)r" r r r
downloadedy s z DownloadProgressMixin.downloadedc C s | j dkrdS td| j d S )Ng z... z/s)Zavgr )r" r r r download_speed} s
z$DownloadProgressMixin.download_speedc C s | j rd| j S dS )Nzeta %s )ZetaZeta_td)r" r r r
pretty_eta s
z DownloadProgressMixin.pretty_etar3 c c s* x |D ]}|V | j | qW | j d S )N)nextr& )r" itnxr r r iter s
zDownloadProgressMixin.iter)r3 )
r( r) r* r propertyr2 r4 r6 r; r, r r )r% r r- s s
r- c s e Zd Z fddZ ZS ) WindowsMixinc s\ t r jrd _tt j|| t rXtrXtj j _ fdd j_ fdd j_ d S )NFc s j jj S )N)r wrappedisattyr )r" r r s z'WindowsMixin.__init__..c s j jj S )N)r r> flushr )r" r r r@ s )
r Z hide_cursorr r= r r Z AnsiToWin32r r? rA )r" r# r$ )r% )r" r r s
zWindowsMixin.__init__)r( r) r* r r, r r )r% r r= s r= c @ s e Zd ZejZdZdZdS )DownloadProgressBarz
%(percent)d%%z0%(downloaded)s %(download_speed)s %(pretty_eta)sN)r( r) r* sysstdoutr r0 suffixr r r r rB s rB c @ s& e Zd ZejZdZdd Zdd ZdS )DownloadProgressSpinnerz!%(downloaded)s %(download_speed)sc C s" t | dstj| j| _t| jS )N_phaser)hasattr itertoolscycler rG r7 )r" r r r
next_phase s
z"DownloadProgressSpinner.next_phasec C sN | j | }| j }| j| }dj||r*dnd||r6dnd|g}| j| d S )Nr5 r. )r0 rK rE r Zwriteln)r" r0 ZphaserE liner r r update s
z DownloadProgressSpinner.updateN) r( r) r* rC rD r rE rK rM r r r r rF s rF c c sR t r d V nB| j s$tj tjkr,d V n"| jt z
d V W d | jt X d S )N) r r? loggergetEffectiveLevelloggingINFOwriter r )r r r r
hidden_cursor s
rS c @ s$ e Zd Zdd Zdd Zdd ZdS ) RateLimiterc C s || _ d| _d S )Nr ) _min_update_interval_seconds _last_update)r" min_update_interval_secondsr r r r s zRateLimiter.__init__c C s t j }|| j }|| jkS )N)timerV rU )r" ZnowZdeltar r r ready s
zRateLimiter.readyc C s t j | _d S )N)rX rV )r" r r r reset s zRateLimiter.resetN)r( r) r* r rY rZ r r r r rT s rT c @ s. e Zd Zd ddZdd Zdd Zd
d ZdS )
InteractiveSpinnerN-\|/ ?c C s\ || _ |d krtj}|| _t|| _d| _tj|| _ | jj
dt | j d d| _ d S )NFr. z ... r )
_messagerC rD _filerT
_rate_limiter _finishedrI rJ _spin_cyclerR r _width)r" r0 r Z
spin_charsrW r r r r s
zInteractiveSpinner.__init__c C sR d| j }| jj|d| j | | jj| t|| _ | jj | jj d S )Nr. )rc r_ rR lenrA r` rZ )r" statusZbackupr r r _write s
zInteractiveSpinner._writec C s, | j r
d S | jj sd S | jt| j d S )N)ra r` rY rg r7 rb )r" r r r spin s
zInteractiveSpinner.spinc C s4 | j r
d S | j| | jjd | jj d| _ d S )N
T)ra rg r_ rR rA )r" final_statusr r r r& s
zInteractiveSpinner.finish)Nr\ r] )r( r) r* r rg rh r& r r r r r[ s
r[ c @ s. e Zd Zd ddZdd Zdd Zdd Zd
S ) NonInteractiveSpinner< c C s$ || _ d| _t|| _| jd d S )NFZstarted)r^ ra rT r` _update)r" r0 rW r r r r * s
z NonInteractiveSpinner.__init__c C s | j j tjd| j| d S )Nz%s: %s)r` rZ rN infor^ )r" rf r r r rm 0 s
z NonInteractiveSpinner._updatec C s& | j r
d S | jj sd S | jd d S )Nzstill running...)ra r` rY rm )r" r r r rh 5 s
zNonInteractiveSpinner.spinc C s$ | j r
d S | jd|f d| _ d S )Nzfinished with status '%s'T)ra rm )r" rj r r r r& < s z NonInteractiveSpinner.finishN)rl )r( r) r* r rm rh r& r r r r rk ) s
rk c c s t jj r"tj tjkr"t| }nt| }y t t j |V W d Q R X W n> t
k
rj |j d Y n* t k
r |j d Y n X |j d d S )NZcancelederrordone)
rC rD r? rN rO rP rQ r[ rk rS KeyboardInterruptr& Exception)r0 Zspinnerr r r open_spinnerC s
rs )/Z
__future__r r rI rC r r r rX
contextlibrP Z
pip.compatr Z pip.utilsr Zpip.utils.loggingr Z pip._vendorr
Zpip._vendor.progress.barr r Z pip._vendor.progress.helpersr
r r Z pip._vendor.progress.spinnerr r rr Z getLoggerr( rN r Z_BaseBarobjectr r- r= rB rF contextmanagerrS rT r[ rk rs r r r r sB
7
!0 __pycache__/logging.cpython-36.pyc 0000644 00000007447 14722165061 0013050 0 ustar 00 3
.
g @ s d dl mZ d dlZd dlZd dlZd dlZy d dlZW n ek
rT d dlZY nX d dl m
Z
d dl m Z yd dl
mZ W n ek
r dZY nX ej Zd e_ejdddZd d
ZG d d d ejZd
d ZG dd dejZG dd dejj Z G dd dej Z dS ) )absolute_importN)WINDOWS)
ensure_dir)colorama c c s. t j| 7 _z
dV W dt j| 8 _X dS )zv
A context manager which will cause the log output to be indented for any
log messages emitted inside it.
N)
_log_state indentation)Znum r /usr/lib/python3.6/logging.py
indent_log s
r c C s t tddS )Nr r )getattrr r r r r
get_indentation) s r
c @ s e Zd Zdd ZdS )IndentingFormatterc C s, t jj| |}djdd |jdD }|S )z
Calls the standard formatter, but will indent all of the log messages
by our current indentation level.
c S s g | ]}d t | qS ) )r
).0liner r r
6 s z-IndentingFormatter.format..T)logging Formatterformatjoin
splitlines)selfrecordZ formattedr r r
r / s
zIndentingFormatter.formatN)__name__
__module__ __qualname__r r r r r
r - s r c s fdd}|S )Nc s dj t | tjjg S )Nr )r listr ZStyleZ RESET_ALL)Zinp)colorsr r
wrapped= s z _color_wrap..wrappedr )r r r )r r
_color_wrap< s r! c @ sT e Zd Zer2ejeejjfej eejj
fgZ ng Z dddZ dd Z
dd ZdS ) ColorizedStreamHandlerNc C s( t jj| | tr$tr$tj| j| _d S )N)r
StreamHandler__init__r r AnsiToWin32stream)r r& r r r
r$ N s z ColorizedStreamHandler.__init__c C sR t sdS t| jt js | jn| jj}t|dr:|j r:dS tjj ddkrNdS dS )NFisattyTZTERMZANSI)
r
isinstancer& r% r hasattrr' osenvironget)r Z real_streamr r r
should_colorT s z#ColorizedStreamHandler.should_colorc C sB t jj| |}| j r>x&| jD ] \}}|j|kr ||}P q W |S )N)r r# r r- COLORSlevelno)r r msglevelZcolorr r r
r i s
z ColorizedStreamHandler.format)N)r r r r r ZERRORr! ZForeZREDZWARNINGZYELLOWr. r$ r- r r r r r
r" B s
r" c @ s e Zd Zdd ZdS )BetterRotatingFileHandlerc C s t tjj| j tjjj| S )N) r r* pathdirnameZ baseFilenamer handlersRotatingFileHandler_open)r r r r
r7 w s z BetterRotatingFileHandler._openN)r r r r7 r r r r
r2 u s r2 c @ s e Zd Zdd Zdd ZdS )MaxLevelFilterc C s
|| _ d S )N)r1 )r r1 r r r
r$ ~ s zMaxLevelFilter.__init__c C s |j | jk S )N)r/ r1 )r r r r r
filter s zMaxLevelFilter.filterN)r r r r$ r9 r r r r
r8 | s r8 )r ) Z
__future__r
contextlibr Zlogging.handlersr* Z threading ImportErrorZdummy_threadingZ
pip.compatr Z pip.utilsr Z pip._vendorr ExceptionZlocalr r contextmanagerr r
r r r! r# r" r5 r6 r2 ZFilterr8 r r r r
s0
3 __pycache__/setuptools_build.cpython-36.pyc 0000644 00000000464 14722165061 0015012 0 ustar 00 3
.
g @ s d Z dS )zimport setuptools, tokenize;__file__=%r;f=getattr(tokenize, 'open', open)(__file__);code=f.read().replace('\r\n', '\n');f.close();exec(compile(code, __file__, 'exec'))N)ZSETUPTOOLS_SHIM r r &/usr/lib/python3.6/setuptools_build.py s __pycache__/setuptools_build.cpython-36.opt-1.pyc 0000644 00000000464 14722165061 0015751 0 ustar 00 3
.
g @ s d Z dS )zimport setuptools, tokenize;__file__=%r;f=getattr(tokenize, 'open', open)(__file__);code=f.read().replace('\r\n', '\n');f.close();exec(compile(code, __file__, 'exec'))N)ZSETUPTOOLS_SHIM r r &/usr/lib/python3.6/setuptools_build.py s __pycache__/__init__.cpython-36.opt-1.pyc 0000644 00000053713 14722165061 0014115 0 ustar 00 3
.
gyk @ s d dl mZ d dlmZ d dlZd dlZd dlZd dlZd dlZ d dl
Z
d dl Z d dl Z d dl
Z
d dlZd dlZd dlZd dlZd dlZd dlmZ d dlmZmZmZ d dlmZmZm Z m Z m Z m Z d dl m!Z! d dl"m#Z# d d l$m%Z% d d
l&m'Z' e%r d d lm(Z) n d d lm)Z) d
ddddddddddddddd d d d d d!d"d#d$gZ*e j+e,Z-dzZ.d{Z/d|Z0d}Z1e0e. e1 e/ Z2e0e1 Z3yd dl4Z4e3e.7 Z3W n e5k
r e-j6d1 Y nX yd dl7Z7e3e/7 Z3W n e5k
r e-j6d2 Y nX d3d4 Z8d5d! Z9d6d Z:e'd7d8d9d~d;d
Z;dd Z=dd@dZ>dAdB Z?dCd Z@dDd ZAdEd ZBdFd ZCdGd ZDejEfdHdIZFdJd ZGdKd ZHddMdZIdNd ZJdOd ZKdPdQ ZLdRdS ZMdTdU ZNdVdW ZOdXdY ZPdZd[ ZQdLedLd:d:fd\d]ZRd^d_ ZSd`da ZTdbd ZUdcdd ZVdded ZWdfd ZXdgd ZYddid ZZdjdk Z[dldm Z\G dndo doe]Z^G dpdq dqe)Z_ej`drds Zadtd ZbG dudv dve]Zcddwd$Zddxdy ZedS ) )absolute_import)dequeN)InstallationError)console_to_str
expanduser stdlib_pkgs)
site_packages user_siterunning_under_virtualenvvirtualenv_no_globalwrite_delete_marker_filedistutils_scheme)
pkg_resources)input)PY2)retry)BytesIO)StringIOrmtree display_path
backup_dirasksplitext format_sizeis_installable_dir is_svn_page
file_contentssplit_leading_dirhas_leading_dirnormalize_pathrenamesget_terminal_sizeget_prog
unzip_file
untar_file unpack_filecall_subprocesscaptured_stdout
ensure_dirARCHIVE_EXTENSIONSSUPPORTED_EXTENSIONSget_installed_version.tar.bz2.tbz.tar.xz.txz.tlz.tar.lz .tar.lzma.zip.whl.tar.gz.tgz.tarzbz2 module is not availablez lzma module is not availablec O s, yt | S tk
r& |||Y nX d S )N)
__import__ ImportError)Zpkg_or_module_stringZ
ExceptionTypeargskwargs r< /usr/lib/python3.6/__init__.pyimport_or_raiseI s r> c C sD yt j| W n0 tk
r> } z|jtjkr. W Y dd}~X nX dS )z os.path.makedirs without EEXIST.N)osmakedirsOSErrorerrnoZEEXIST)pather< r< r= r( P s
c
C sD y$t jjtjd dkr"dtj S W n tttfk
r> Y nX dS )Nr __main__.py-cz %s -m pipZpip)rE rF ) r? rC basenamesysargv
executableAttributeError TypeError
IndexErrorr< r< r< r= r" Y s i i )Zstop_max_delayZ
wait_fixedFc C s t j| |td d S )N)
ignore_errorsonerror)shutilr rmtree_errorhandler)dirrN r< r< r= r c s c C s2 t j|jtj@ r,t j|tj | | dS dS )zOn Windows, the files in .svn are read-only, so when rmtree() tries to
remove them, an exception is thrown. We catch that here, remove the
read-only attribute, and hopefully continue without problems.N)r? statst_modeS_IREADchmodS_IWRITE)funcrC exc_infor< r< r= rQ i s
rQ c C st t jjt jj| } tjd dkrB| jtj d} | jtj d} | j
t j t jj rpd| t
t j d } | S )zTGives the display value for a given path, making it relative to cwd
if possible.r replace.N)r? rC normcaseabspathrH version_infodecodegetfilesystemencodingencodegetdefaultencoding
startswithgetcwdseplen)rC r< r< r= r x s .bakc C s: d}|}x(t jj| | r0|d7 }|t| }q
W | | S )z\Figure out the name of a directory to back up the given dir to
(adding .bak, .bak2, etc) )r? rC existsstr)rR extn extensionr< r< r= r s c C s2 x&t jjddj D ]}||kr|S qW t| |S )NZPIP_EXISTS_ACTION )r? environgetsplitr )messageoptionsactionr< r< r= ask_path_exists s rv c C sZ xTt jjdrtd| t| }|j j }||krNtd|dj|f q|S qW dS )z@Ask the message interactively, with the given possible responsesZ PIP_NO_INPUTz7No input was expected ($PIP_NO_INPUT set); question: %sz[^<]*Revision \d+:z#Powered by (?:]*?>)?Subversion)researchI)Zhtmlr< r< r= r s c C s$ t | d}|j jdS Q R X d S )Nrbzutf-8)openreadr` )filenamefpr< r< r= r s c c s x| j |}|sP |V qW dS )z7Yield pieces of data from a file-like object until EOF.N)r )filesizechunkr< r< r= read_chunks s
r c C sh | j dj d} d| krHd| kr4| jd| jdk s s r c C s8 x2t jD ](}tjj|| jd }tjj|rdS qW dS )z$Is distribution an editable install?z .egg-linkTF)rH rC r? r{ project_namer )r Z path_itemegg_linkr< r< r= dist_is_editableH s
r c sl | r
t ndd |r dd ndd |r6dd ndd |rHtnd d
fd d tjD S )
a
Return a list of installed Distribution objects.
If ``local_only`` is True (default), only return installations
local to the current virtualenv, if in a virtualenv.
``skip`` argument is an iterable of lower-case project names to
ignore; defaults to stdlib_pkgs
If ``editables`` is False, don't report editables.
If ``editables_only`` is True , only report editables.
If ``user_only`` is True , only report installations in the user
site directory.
c S s dS )NTr< )dr< r< r=
local_testj s z/get_installed_distributions..local_testc S s dS )NTr< )r r< r< r=
editable_testn s z2get_installed_distributions..editable_testc S s
t | S )N)r )r r< r< r= r q s c S s t | S )N)r )r r< r< r= editables_only_testu s z8get_installed_distributions..editables_only_testc S s dS )NTr< )r r< r< r= r x s c S s dS )NTr< )r r< r< r= user_test~ s z.get_installed_distributions..user_testc s: g | ]2}|r|j kr |r|r|r|qS r< )key).0r )r r r skipr r< r=
s
z/get_installed_distributions..)r r r working_set)Z
local_onlyr Zinclude_editablesZeditables_onlyZ user_onlyr< )r r r r r r= get_installed_distributionsQ s
r c C s g }t r6t r |jt qN|jt trN|jt ntrD|jt |jt x0|D ](}tjj|| jd }tjj |rT|S qTW dS )a
Return the path for the .egg-link file if it exists, otherwise, None.
There's 3 scenarios:
1) not in a virtualenv
try to find in site.USER_SITE, then site_packages
2) in a no-global virtualenv
try to find in site_packages
3) in a yes-global virtualenv
try to find in site_packages, then site.USER_SITE
(don't look in global location)
For #1 and #3, there could be odd cases, where there's an egg-link in 2
locations.
This method will just return the first one found.
z .egg-linkN)
r
r appendr r r? rC r{ r r )r ZsitesZsiteZegglinkr< r< r=
egg_link_path s
r c C s t | }|r|S | jS )z
Get the site-packages location of this distribution. Generally
this is dist.location, except in the case of develop-installed
packages, where dist.location is the source code location, and we
want to know where the egg-link file is.
)r location)r r r< r< r= r s r c
C s dd } | dp | dp | d}|sZy(t jt j t j}| |}t j| W n Y nX |szt jjddt jjdd f}t|d t|d fS )
zlReturns a tuple (x, y) representing the width(x) and the height(x)
in characters of the terminal window.c S sP y4dd l }dd l}dd l}|jd|j| |jd}W n
d S |dkrLd S |S )Nr ZhhZ1234)r r )fcntltermiosstructunpackZioctlZ
TIOCGWINSZ)fdr r r crr< r< r= ioctl_GWINSZ s z'get_terminal_size..ioctl_GWINSZr ri rZ ZLINES ZCOLUMNSP )r? r ctermidO_RDONLYcloserp rq int)r r r r< r< r= r! s c C s t jd} t j| | S )zBGet the current umask which involves having to set it temporarily.r )r? umask)maskr< r< r=
current_umask s
r c
C s t | t| d}ztj|dd}t|j o0|}x|j D ]}|j}|j|}|} |rdt |d } t
j j || } t
j j
| }
| jds| jdrt | qd}n8| j jtrRd}n$| j jdrfd}ntjd| d }tj| |}zxt d
d |j
D }xZ|j
D ]L}|j }|d krq|rt |d
}t
jj||}|j rt | q|j rDy|j|| W n8 tk
r@ } ztjd| |j | wW Y dd}~X nX qy|j|} W n< ttfk
r } ztjd| |j | wW Y dd}~X nX t t
jj| t|d}
tj| |
W dQ R X | j |j|| |j d@ rt
j |dt dB qW W d|j X dS )a
Untar the file (with path `filename`) to the destination `location`.
All files are written based on system defaults and umask (i.e. permissions
are not preserved), except that regular file members with any execute
permissions (user, group, or world) have "chmod +x" applied after being
written. Note that for windows, any execute changes using os.chmod are
no-ops per the python docs.
z.gzz.tgzzr:gzzr:bz2zr:xzz.tarrz-Cannot determine compression type for file %szr:*c S s g | ]}|j d kr|j qS )pax_global_header)r )r memberr< r< r= r ( s z untar_file..r ri z/In the tar file %s the member %s is invalid: %sNr r i ) r( ry r BZ2_EXTENSIONS
XZ_EXTENSIONSloggerwarningtarfiler r Z
getmembersr r r? rC r{ r~ ZissymZ_extract_memberrw Z extractfileKeyErrorrK r rP Z copyfileobjr utimer rV r ) r r r Ztarr r r rC excr Zdestfpr< r< r= r$
s`
c C s t jj| } |dks,| j jts,tj| rDt| || jd d n|dkslt j
| sl| j jt t t
rxt| | nX|r|jdrtt| rddlm} |d|j j| n tjd | || td
| d S ) Nzapplication/zipz.whl)r zapplication/x-gzipz text/htmlr )
Subversionzsvn+zZCannot unpack file %s (downloaded from %s, content-type: %s); cannot detect archive formatz%Cannot determine archive format of %s)r? rC r ry r ZIP_EXTENSIONSr Z
is_zipfiler# r Z
is_tarfileTAR_EXTENSIONSr r r$ rd r r Zpip.vcs.subversionr Zurlr r criticalr )r r Z content_typelinkr r< r< r= r% Y s,
raisec C s, |r
d }nt j}|d krng }xF| D ]>} d| ksFd| ksFd| ksFd| krVd| jdd } |j| q"W dj|}tjd| tjj }
|r|
j
| y t j | t j d |||
d} W n2 t
k
r } ztjd | | W Y d d } ~ X nX |d k rNg }
x\t| jj }|sP |j }|
j|d tj tjkr:tj| q|d k r|j qW | j |d k r~| jrt|jd
n
|jd | jr|d krtj tjkr| rtjd
| tjdj|
d td|| j|f n:|dkrtj d|| j| n |dkrnt dt | |s(dj|
S d S )N
"'z"%s"z\"zRunning command %s)stderrstdinstdoutcwdenvz#Error %s while executing command %serrordoner z Complete output from command %s:ro z)
----------------------------------------z,Command "%s" failed with error code %s in %swarnz$Command "%s" had error code %s in %signorez Invalid value: on_returncode=%s)
subprocessPIPEr[ r r{ r debugr? rp copyupdatePopenZSTDOUTrw r r r readlinerstripZgetEffectiveLevel std_loggingDEBUGZspinwait
returncodeZfinishr r r
ValueErrorrepr)cmdZ show_stdoutr Z
on_returncodeZ command_descZ
extra_environZspinnerr Z cmd_partspartr procr Z
all_outputliner< r< r= r& z sz
c C sh t | d}|j }W dQ R X dtjddg}x4|D ],}y|j|}W n tk
r\ w4Y nX P q4W |S )aR Return the contents of *filename*.
Try to decode the file contents with utf-8, the preferred system encoding
(e.g., cp1252 on some Windows machines), and latin1, in that order.
Decoding a byte string with latin1 will never raise an error. In the worst
case, the returned string will contain some garbage characters.
r Nzutf-8Flatin1)r r localegetpreferredencodingr` UnicodeDecodeError)r r r Z encodingsencr< r< r= read_text_file s
r
c C s t j| t| d S )N)r? r@ r )Z build_dirr< r< r= _make_build_dir s
r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) FakeFilezQWrap a list of lines in an object with readline() to make
ConfigParser happy.c C s dd |D | _ d S )Nc s s | ]
}|V qd S )Nr< )r lr< r< r= s z$FakeFile.__init__..)_gen)selflinesr< r< r= __init__ s zFakeFile.__init__c C sD y*y
t | jS tk
r& | jj S X W n tk
r> dS X d S )Nro )nextr NameError
StopIteration)r r< r< r= r s
zFakeFile.readlinec C s | j S )N)r )r r< r< r= __iter__ s zFakeFile.__iter__N)__name__
__module__ __qualname____doc__r r r r< r< r< r= r s r c @ s$ e Zd Zedd Zedd ZdS )
StreamWrapperc C s || _ | S )N) orig_stream)clsr r< r< r= from_stream s zStreamWrapper.from_streamc C s | j jS )N)r encoding)r r< r< r= r" s zStreamWrapper.encodingN)r r r classmethodr! propertyr" r< r< r< r= r s r c
c s@ t t| }tt| tj| zt t| V W dtt| | X dS )zReturn a context manager used by captured_stdout/stdin/stderr
that temporarily replaces the sys stream *stream_name* with a StringIO.
Taken from Lib/support/__init__.py in the CPython repo.
N)getattrrH setattrr r! )Z stream_nameZ orig_stdoutr< r< r= captured_output s
r' c C s t dS )zCapture the output of sys.stdout:
with captured_stdout() as stdout:
print('hello')
self.assertEqual(stdout.getvalue(), 'hello
')
Taken from Lib/support/__init__.py in the CPython repo.
r )r' r< r< r< r= r' ( s c @ s e Zd ZdZdd Zdd ZdS )cached_propertyzA property that is only computed once per instance and then replaces
itself with an ordinary attribute. Deleting the attribute resets the
property.
Source: https://github.com/bottlepy/bottle/blob/0.11.5/bottle.py#L175
c C s t |d| _|| _d S )Nr )r% r rX )r rX r< r< r= r < s zcached_property.__init__c C s( |d kr | S | j | }|j| j j< |S )N)rX __dict__r )r objr valuer< r< r= __get__@ s zcached_property.__get__N)r r r r r r, r< r< r< r= r( 4 s r( c C s@ t jj| }|dkr t j }n
t j|}|j|}|r<|jS dS )zCGet the installed version of dist_name avoiding pkg_resources cacheN)r Z RequirementparseZ
WorkingSetr version)Z dist_nameZ lookup_dirsZreqr r r< r< r= r+ H s
c C s t | dd dS )z Consume an iterable at C speed.r )maxlenN)r )iteratorr< r< r= consume\ s r1 )r, r- )r. r/ r0 r1 r2 )r3 r4 )r5 r6 r7 )F)rh )T)T)TNr NNN)N)fZ
__future__r collectionsr
contextlibrB ior Zloggingr r r? r rP rS r rH r r Zpip.exceptionsr Z
pip.compatr r r Z
pip.locationsr r r
r r r
Z pip._vendorr Zpip._vendor.six.movesr Zpip._vendor.sixr Zpip._vendor.retryingr r r __all__Z getLoggerr r r r r r r) r* bz2r9 r Zlzmar> r( r" r rQ r r rv r r r r r DEFAULT_BUFFER_SIZEr r r r r r r r r r r r r r r r! r r# r$ r% r& r
r objectr r contextmanagerr' r' r( r+ r1 r< r< r< r= s
5%
+L!
_
__pycache__/glibc.cpython-36.pyc 0000644 00000002503 14722165061 0012466 0 ustar 00 3
.
g{ @ sP d dl mZ d dlZd dlZd dlZd dlZdd Zdd Zdd Zd d
Z dS ) )absolute_importNc C sP t jd} y
| j}W n tk
r( dS X t j|_| }t|tsL|jd}|S )z9Returns glibc version string, or None if not using glibc.Nascii) ctypesZCDLLgnu_get_libc_versionAttributeErrorZc_char_pZrestype
isinstancestrdecode)Zprocess_namespacer version_str r /usr/lib/python3.6/glibc.pyglibc_version_string s
r
c C sH t jd| }|s$tjd| t dS t|jd|koFt|jd|kS )Nz$(?P[0-9]+)\.(?P[0-9]+)z=Expected glibc version with 2 components major.minor, got: %sFmajorminor)rematchwarningswarnRuntimeWarningintgroup)r
required_major
minimum_minormr r r check_glibc_version# s
r c C s t }|d krdS t|| |S )NF)r
r )r r r
r r r have_compatible_glibc3 s r c C s" t } | d krtj S d| fS d S )NZglibc)r
platformlibc_ver)Z
glibc_versionr r r r K s r )
Z
__future__r r r r r r
r r r r r r r s __pycache__/outdated.cpython-36.pyc 0000644 00000011147 14722165061 0013223 0 ustar 00 3
.
ge @ s d dl mZ d dlZd dlZd dlZd dlZd dlZd dlm Z d dl
m Z d dl
mZmZ d dlmZ d dlmZmZ d dlmZmZ d d lmZ d
Zeje Z G d d d e Z G d
d de Z dd Z!dd Z"dd Z#dS ) )absolute_importN)lockfile)version)
total_secondsWINDOWS)PyPI)USER_CACHE_DIRrunning_under_virtualenv)
ensure_dirget_installed_version)check_path_ownerz%Y-%m-%dT%H:%M:%SZc @ s e Zd Zdd Zdd ZdS )VirtualenvSelfCheckStatec C s\ t jjtjd| _y&t| j}tj|| _ W d Q R X W n t
t fk
rV i | _ Y nX d S )Nzpip-selfcheck.json) ospathjoinsysprefixstatefile_pathopenjsonloadstateIOError
ValueError)self statefile r /usr/lib/python3.6/outdated.py__init__ s z!VirtualenvSelfCheckState.__init__c
C s: t | jd$}tj|jt|d|ddd W d Q R X d S )Nw)
last_check pypi_versionT,:) sort_keys
separators)r" r# )r r r dumpstrftimeSELFCHECK_DATE_FMT)r r! current_timer r r r save$ s z VirtualenvSelfCheckState.saveN)__name__
__module__ __qualname__r r* r r r r r
s
r
c @ s e Zd Zdd Zdd ZdS )GlobalSelfCheckStatec C sb t jjtd| _y,t| j}tj|tj | _
W d Q R X W n t t t
fk
r\ i | _
Y nX d S )Nzselfcheck.json)r r r r r r r r r r r r r KeyError)r r r r r r 3 s z GlobalSelfCheckState.__init__c C s t tjj| jsd S ttjj| j tj| jz tjj| jrft | j}t
j |}W d Q R X ni }|j t
|d|tj< t | jd}t
j||ddd W d Q R X W d Q R X d S )N)r r! r Tr" r# )r$ r% )r" r# )r r r dirnamer r
r ZLockFileexistsr r r r' r( r r r& )r r! r) r r r r r r* = s
zGlobalSelfCheckState.saveN)r+ r, r- r r* r r r r r. 2 s
r. c C s t r t S t S d S )N)r r
r. r r r r load_selfcheck_statefileX s r2 c C sF ddl } y"| jd}|jdo*d|jdkS | jk
r@ dS X dS )zChecks whether pip was installed by pip
This is used not to display the upgrade message when pip is in fact
installed by system package manager, such as dnf on Fedora.
r NpipZ INSTALLERF)
pkg_resourcesZget_distributionZ has_metadataZget_metadata_linesZDistributionNotFound)r4 Zdistr r r pip_installed_by_pip_ s
r5 c
C sF t d}|dkrdS tj|}d} yt }tjj }d|jkrxd|jkrxtjj|jd t}t || dk rx|jd }|dkr| j
t j dd id
}|j
d d tt|j d
tjdD d }|j|| tj|}||k r|j|jkrt rtrd} nd} tjd||| W n$ tk
r@ tjddd Y nX dS )zCheck for an update for pip.
Limit the frequency of checks to once per week. State is stored either in
the active virtualenv or in the user's USER_CACHE_DIR keyed off the prefix
of the pip script path.
r3 Nr r! < ZAcceptzapplication/json)Zheadersc S s g | ]}t j|js|qS r )packaging_versionparseZ
is_prerelease).0vr r r
s z%pip_version_check..Zreleases)key z
python -m pipzYou are using pip version %s, however version %s is available.
You should consider upgrading via the '%s install --upgrade pip' command.z5There was an error checking the latest version of pipT)exc_info i`' i: )r r9 r: r2 datetimeZutcnowr Zstrptimer( r getr Z pip_json_urlZraise_for_statussortedlistr r* Z base_versionr5 r loggerZwarning Exceptiondebug)
ZsessionZinstalled_versionZ pip_versionr! r r) r ZrespZremote_versionZpip_cmdr r r pip_version_checkn sL
rJ )$Z
__future__r rC r ZloggingZos.pathr r Z pip._vendorr Zpip._vendor.packagingr r9 Z
pip.compatr r Z
pip.modelsr Z
pip.locationsr r Z pip.utilsr
r Zpip.utils.filesystemr r( Z getLoggerr+ rG objectr
r. r2 r5 rJ r r r r s&
& __pycache__/logging.cpython-36.opt-1.pyc 0000644 00000007447 14722165061 0014007 0 ustar 00 3
.
g @ s d dl mZ d dlZd dlZd dlZd dlZy d dlZW n ek
rT d dlZY nX d dl m
Z
d dl m Z yd dl
mZ W n ek
r dZY nX ej Zd e_ejdddZd d
ZG d d d ejZd
d ZG dd dejZG dd dejj Z G dd dej Z dS ) )absolute_importN)WINDOWS)
ensure_dir)colorama c c s. t j| 7 _z
dV W dt j| 8 _X dS )zv
A context manager which will cause the log output to be indented for any
log messages emitted inside it.
N)
_log_state indentation)Znum r /usr/lib/python3.6/logging.py
indent_log s
r c C s t tddS )Nr r )getattrr r r r r
get_indentation) s r
c @ s e Zd Zdd ZdS )IndentingFormatterc C s, t jj| |}djdd |jdD }|S )z
Calls the standard formatter, but will indent all of the log messages
by our current indentation level.
c S s g | ]}d t | qS ) )r
).0liner r r
6 s z-IndentingFormatter.format..T)logging Formatterformatjoin
splitlines)selfrecordZ formattedr r r
r / s
zIndentingFormatter.formatN)__name__
__module__ __qualname__r r r r r
r - s r c s fdd}|S )Nc s dj t | tjjg S )Nr )r listr ZStyleZ RESET_ALL)Zinp)colorsr r
wrapped= s z _color_wrap..wrappedr )r r r )r r
_color_wrap< s r! c @ sT e Zd Zer2ejeejjfej eejj
fgZ ng Z dddZ dd Z
dd ZdS ) ColorizedStreamHandlerNc C s( t jj| | tr$tr$tj| j| _d S )N)r
StreamHandler__init__r r AnsiToWin32stream)r r& r r r
r$ N s z ColorizedStreamHandler.__init__c C sR t sdS t| jt js | jn| jj}t|dr:|j r:dS tjj ddkrNdS dS )NFisattyTZTERMZANSI)
r
isinstancer& r% r hasattrr' osenvironget)r Z real_streamr r r
should_colorT s z#ColorizedStreamHandler.should_colorc C sB t jj| |}| j r>x&| jD ] \}}|j|kr ||}P q W |S )N)r r# r r- COLORSlevelno)r r msglevelZcolorr r r
r i s
z ColorizedStreamHandler.format)N)r r r r r ZERRORr! ZForeZREDZWARNINGZYELLOWr. r$ r- r r r r r
r" B s
r" c @ s e Zd Zdd ZdS )BetterRotatingFileHandlerc C s t tjj| j tjjj| S )N) r r* pathdirnameZ baseFilenamer handlersRotatingFileHandler_open)r r r r
r7 w s z BetterRotatingFileHandler._openN)r r r r7 r r r r
r2 u s r2 c @ s e Zd Zdd Zdd ZdS )MaxLevelFilterc C s
|| _ d S )N)r1 )r r1 r r r
r$ ~ s zMaxLevelFilter.__init__c C s |j | jk S )N)r/ r1 )r r r r r
filter s zMaxLevelFilter.filterN)r r r r$ r9 r r r r
r8 | s r8 )r ) Z
__future__r
contextlibr Zlogging.handlersr* Z threading ImportErrorZdummy_threadingZ
pip.compatr Z pip.utilsr Z pip._vendorr ExceptionZlocalr r contextmanagerr r
r r r! r# r" r5 r6 r2 ZFilterr8 r r r r
s0
3 __pycache__/__init__.cpython-36.pyc 0000644 00000053770 14722165061 0013161 0 ustar 00 3
.
gyk @ s d dl mZ d dlmZ d dlZd dlZd dlZd dlZd dlZ d dl
Z
d dl Z d dl Z d dl
Z
d dlZd dlZd dlZd dlZd dlZd dlmZ d dlmZmZmZ d dlmZmZm Z m Z m Z m Z d dl m!Z! d dl"m#Z# d d l$m%Z% d d
l&m'Z' e%r d d lm(Z) n d d lm)Z) d
ddddddddddddddd d d d d d!d"d#d$gZ*e j+e,Z-dzZ.d{Z/d|Z0d}Z1e0e. e1 e/ Z2e0e1 Z3yd dl4Z4e3e.7 Z3W n e5k
r e-j6d1 Y nX yd dl7Z7e3e/7 Z3W n e5k
r e-j6d2 Y nX d3d4 Z8d5d! Z9d6d Z:e'd7d8d9d~d;d
Z;dd Z=dd@dZ>dAdB Z?dCd Z@dDd ZAdEd ZBdFd ZCdGd ZDejEfdHdIZFdJd ZGdKd ZHddMdZIdNd ZJdOd ZKdPdQ ZLdRdS ZMdTdU ZNdVdW ZOdXdY ZPdZd[ ZQdLedLd:d:fd\d]ZRd^d_ ZSd`da ZTdbd ZUdcdd ZVdded ZWdfd ZXdgd ZYddid ZZdjdk Z[dldm Z\G dndo doe]Z^G dpdq dqe)Z_ej`drds Zadtd ZbG dudv dve]Zcddwd$Zddxdy ZedS ) )absolute_import)dequeN)InstallationError)console_to_str
expanduser stdlib_pkgs)
site_packages user_siterunning_under_virtualenvvirtualenv_no_globalwrite_delete_marker_filedistutils_scheme)
pkg_resources)input)PY2)retry)BytesIO)StringIOrmtree display_path
backup_dirasksplitext format_sizeis_installable_dir is_svn_page
file_contentssplit_leading_dirhas_leading_dirnormalize_pathrenamesget_terminal_sizeget_prog
unzip_file
untar_file unpack_filecall_subprocesscaptured_stdout
ensure_dirARCHIVE_EXTENSIONSSUPPORTED_EXTENSIONSget_installed_version.tar.bz2.tbz.tar.xz.txz.tlz.tar.lz .tar.lzma.zip.whl.tar.gz.tgz.tarzbz2 module is not availablez lzma module is not availablec O s, yt | S tk
r& |||Y nX d S )N)
__import__ ImportError)Zpkg_or_module_stringZ
ExceptionTypeargskwargs r< /usr/lib/python3.6/__init__.pyimport_or_raiseI s r> c C sD yt j| W n0 tk
r> } z|jtjkr. W Y dd}~X nX dS )z os.path.makedirs without EEXIST.N)osmakedirsOSErrorerrnoZEEXIST)pather< r< r= r( P s
c
C sD y$t jjtjd dkr"dtj S W n tttfk
r> Y nX dS )Nr __main__.py-cz %s -m pipZpip)rE rF ) r? rC basenamesysargv
executableAttributeError TypeError
IndexErrorr< r< r< r= r" Y s i i )Zstop_max_delayZ
wait_fixedFc C s t j| |td d S )N)
ignore_errorsonerror)shutilr rmtree_errorhandler)dirrN r< r< r= r c s c C s2 t j|jtj@ r,t j|tj | | dS dS )zOn Windows, the files in .svn are read-only, so when rmtree() tries to
remove them, an exception is thrown. We catch that here, remove the
read-only attribute, and hopefully continue without problems.N)r? statst_modeS_IREADchmodS_IWRITE)funcrC exc_infor< r< r= rQ i s
rQ c C st t jjt jj| } tjd dkrB| jtj d} | jtj d} | j
t j t jj rpd| t
t j d } | S )zTGives the display value for a given path, making it relative to cwd
if possible.r replace.N)r? rC normcaseabspathrH version_infodecodegetfilesystemencodingencodegetdefaultencoding
startswithgetcwdseplen)rC r< r< r= r x s .bakc C s: d}|}x(t jj| | r0|d7 }|t| }q
W | | S )z\Figure out the name of a directory to back up the given dir to
(adding .bak, .bak2, etc) )r? rC existsstr)rR extn extensionr< r< r= r s c C s2 x&t jjddj D ]}||kr|S qW t| |S )NZPIP_EXISTS_ACTION )r? environgetsplitr )messageoptionsactionr< r< r= ask_path_exists s rv c C sZ xTt jjdrtd| t| }|j j }||krNtd|dj|f q|S qW dS )z@Ask the message interactively, with the given possible responsesZ PIP_NO_INPUTz7No input was expected ($PIP_NO_INPUT set); question: %sz[^<]*Revision \d+:z#Powered by (?:]*?>)?Subversion)researchI)Zhtmlr< r< r= r s c C s$ t | d}|j jdS Q R X d S )Nrbzutf-8)openreadr` )filenamefpr< r< r= r s c c s x| j |}|sP |V qW dS )z7Yield pieces of data from a file-like object until EOF.N)r )filesizechunkr< r< r= read_chunks s
r c C sh | j dj d} d| krHd| kr4| jd| jdk s s r c C s8 x2t jD ](}tjj|| jd }tjj|rdS qW dS )z$Is distribution an editable install?z .egg-linkTF)rH rC r? r{ project_namer )r Z path_itemegg_linkr< r< r= dist_is_editableH s
r c sl | r
t ndd |r dd ndd |r6dd ndd |rHtnd d
fd d tjD S )
a
Return a list of installed Distribution objects.
If ``local_only`` is True (default), only return installations
local to the current virtualenv, if in a virtualenv.
``skip`` argument is an iterable of lower-case project names to
ignore; defaults to stdlib_pkgs
If ``editables`` is False, don't report editables.
If ``editables_only`` is True , only report editables.
If ``user_only`` is True , only report installations in the user
site directory.
c S s dS )NTr< )dr< r< r=
local_testj s z/get_installed_distributions..local_testc S s dS )NTr< )r r< r< r=
editable_testn s z2get_installed_distributions..editable_testc S s
t | S )N)r )r r< r< r= r q s c S s t | S )N)r )r r< r< r= editables_only_testu s z8get_installed_distributions..editables_only_testc S s dS )NTr< )r r< r< r= r x s c S s dS )NTr< )r r< r< r= user_test~ s z.get_installed_distributions..user_testc s: g | ]2}|r|j kr |r|r|r|qS r< )key).0r )r r r skipr r< r=
s
z/get_installed_distributions..)r r r working_set)Z
local_onlyr Zinclude_editablesZeditables_onlyZ user_onlyr< )r r r r r r= get_installed_distributionsQ s
r c C s g }t r6t r |jt qN|jt trN|jt ntrD|jt |jt x0|D ](}tjj|| jd }tjj |rT|S qTW dS )a
Return the path for the .egg-link file if it exists, otherwise, None.
There's 3 scenarios:
1) not in a virtualenv
try to find in site.USER_SITE, then site_packages
2) in a no-global virtualenv
try to find in site_packages
3) in a yes-global virtualenv
try to find in site_packages, then site.USER_SITE
(don't look in global location)
For #1 and #3, there could be odd cases, where there's an egg-link in 2
locations.
This method will just return the first one found.
z .egg-linkN)
r
r appendr r r? rC r{ r r )r ZsitesZsiteZegglinkr< r< r=
egg_link_path s
r c C s t | }|r|S | jS )z
Get the site-packages location of this distribution. Generally
this is dist.location, except in the case of develop-installed
packages, where dist.location is the source code location, and we
want to know where the egg-link file is.
)r location)r r r< r< r= r s r c
C s dd } | dp | dp | d}|sZy(t jt j t j}| |}t j| W n Y nX |szt jjddt jjdd f}t|d t|d fS )
zlReturns a tuple (x, y) representing the width(x) and the height(x)
in characters of the terminal window.c S sP y4dd l }dd l}dd l}|jd|j| |jd}W n
d S |dkrLd S |S )Nr ZhhZ1234)r r )fcntltermiosstructunpackZioctlZ
TIOCGWINSZ)fdr r r crr< r< r= ioctl_GWINSZ s z'get_terminal_size..ioctl_GWINSZr ri rZ ZLINES ZCOLUMNSP )r? r ctermidO_RDONLYcloserp rq int)r r r r< r< r= r! s c C s t jd} t j| | S )zBGet the current umask which involves having to set it temporarily.r )r? umask)maskr< r< r=
current_umask s
r c
C s t | t| d}ztj|dd}t|j o0|}x|j D ]}|j}|j|}|} |rdt |d } t
j j || } t
j j
| }
| jds| jdrt | qd}n8| j jtrRd}n$| j jdrfd}ntjd| d }tj| |}zxt d
d |j
D }xZ|j
D ]L}|j }|d krq|rt |d
}t
jj||}|j rt | q|j rDy|j|| W n8 tk
r@ } ztjd| |j | wW Y dd}~X nX qy|j|} W n< ttfk
r } ztjd| |j | wW Y dd}~X nX t t
jj| t|d}
tj| |
W dQ R X | j |j|| |j d@ rt
j |dt dB qW W d|j X dS )a
Untar the file (with path `filename`) to the destination `location`.
All files are written based on system defaults and umask (i.e. permissions
are not preserved), except that regular file members with any execute
permissions (user, group, or world) have "chmod +x" applied after being
written. Note that for windows, any execute changes using os.chmod are
no-ops per the python docs.
z.gzz.tgzzr:gzzr:bz2zr:xzz.tarrz-Cannot determine compression type for file %szr:*c S s g | ]}|j d kr|j qS )pax_global_header)r )r memberr< r< r= r ( s z untar_file..r ri z/In the tar file %s the member %s is invalid: %sNr r i ) r( ry r BZ2_EXTENSIONS
XZ_EXTENSIONSloggerwarningtarfiler r Z
getmembersr r r? rC r{ r~ ZissymZ_extract_memberrw Z extractfileKeyErrorrK r rP Z copyfileobjr utimer rV r ) r r r Ztarr r r rC excr Zdestfpr< r< r= r$
s`
c C s t jj| } |dks,| j jts,tj| rDt| || jd d n|dkslt j
| sl| j jt t t
rxt| | nX|r|jdrtt| rddlm} |d|j j| n tjd | || td
| d S ) Nzapplication/zipz.whl)r zapplication/x-gzipz text/htmlr )
Subversionzsvn+zZCannot unpack file %s (downloaded from %s, content-type: %s); cannot detect archive formatz%Cannot determine archive format of %s)r? rC r ry r ZIP_EXTENSIONSr Z
is_zipfiler# r Z
is_tarfileTAR_EXTENSIONSr r r$ rd r r Zpip.vcs.subversionr Zurlr r criticalr )r r Z content_typelinkr r< r< r= r% Y s,
raisec C s, |r
d }nt j}|d krng }xF| D ]>} d| ksFd| ksFd| ksFd| krVd| jdd } |j| q"W dj|}tjd| tjj }
|r|
j
| y t j | t j d |||
d} W n2 t
k
r } ztjd | | W Y d d } ~ X nX |d k rNg }
x\t| jj }|sP |j }|
j|d tj tjkr:tj| q|d k r|j qW | j |d k r~| jrt|jd
n
|jd | jr|d krtj tjkr| rtjd
| tjdj|
d td|| j|f n:|dkrtj d|| j| n |dkrnt dt | |s(dj|
S d S )N
"'z"%s"z\"zRunning command %s)stderrstdinstdoutcwdenvz#Error %s while executing command %serrordoner z Complete output from command %s:ro z)
----------------------------------------z,Command "%s" failed with error code %s in %swarnz$Command "%s" had error code %s in %signorez Invalid value: on_returncode=%s)
subprocessPIPEr[ r r{ r debugr? rp copyupdatePopenZSTDOUTrw r r r readlinerstripZgetEffectiveLevel std_loggingDEBUGZspinwait
returncodeZfinishr r r
ValueErrorrepr)cmdZ show_stdoutr Z
on_returncodeZ command_descZ
extra_environZspinnerr Z cmd_partspartr procr Z
all_outputliner< r< r= r& z sz
c C sx t | d}|j }W dQ R X dtjddg}x4|D ],}y|j|}W n tk
r\ w4Y nX P q4W t|tkstt|S )aR Return the contents of *filename*.
Try to decode the file contents with utf-8, the preferred system encoding
(e.g., cp1252 on some Windows machines), and latin1, in that order.
Decoding a byte string with latin1 will never raise an error. In the worst
case, the returned string will contain some garbage characters.
r Nzutf-8Flatin1) r r localegetpreferredencodingr` UnicodeDecodeErrortyper} AssertionError)r r r Z encodingsencr< r< r= read_text_file s
r c C s t j| t| d S )N)r? r@ r )Z build_dirr< r< r= _make_build_dir s
r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) FakeFilezQWrap a list of lines in an object with readline() to make
ConfigParser happy.c C s dd |D | _ d S )Nc s s | ]
}|V qd S )Nr< )r lr< r< r= s z$FakeFile.__init__..)_gen)selflinesr< r< r= __init__ s zFakeFile.__init__c C sD y*y
t | jS tk
r& | jj S X W n tk
r> dS X d S )Nro )nextr NameError
StopIteration)r r< r< r= r s
zFakeFile.readlinec C s | j S )N)r )r r< r< r= __iter__ s zFakeFile.__iter__N)__name__
__module__ __qualname____doc__r r r r< r< r< r= r s r c @ s$ e Zd Zedd Zedd ZdS )
StreamWrapperc C s || _ | S )N) orig_stream)clsr! r< r< r= from_stream s zStreamWrapper.from_streamc C s | j jS )N)r! encoding)r r< r< r= r$ s zStreamWrapper.encodingN)r r r classmethodr# propertyr$ r< r< r< r= r s r c
c s@ t t| }tt| tj| zt t| V W dtt| | X dS )zReturn a context manager used by captured_stdout/stdin/stderr
that temporarily replaces the sys stream *stream_name* with a StringIO.
Taken from Lib/support/__init__.py in the CPython repo.
N)getattrrH setattrr r# )Z stream_nameZ orig_stdoutr< r< r= captured_output s
r) c C s t dS )zCapture the output of sys.stdout:
with captured_stdout() as stdout:
print('hello')
self.assertEqual(stdout.getvalue(), 'hello
')
Taken from Lib/support/__init__.py in the CPython repo.
r )r) r< r< r< r= r' ( s c @ s e Zd ZdZdd Zdd ZdS )cached_propertyzA property that is only computed once per instance and then replaces
itself with an ordinary attribute. Deleting the attribute resets the
property.
Source: https://github.com/bottlepy/bottle/blob/0.11.5/bottle.py#L175
c C s t |d| _|| _d S )Nr )r' r rX )r rX r< r< r= r < s zcached_property.__init__c C s( |d kr | S | j | }|j| j j< |S )N)rX __dict__r )r objr" valuer< r< r= __get__@ s zcached_property.__get__N)r r r r r r. r< r< r< r= r* 4 s r* c C s@ t jj| }|dkr t j }n
t j|}|j|}|r<|jS dS )zCGet the installed version of dist_name avoiding pkg_resources cacheN)r Z RequirementparseZ
WorkingSetr version)Z dist_nameZ lookup_dirsZreqr r r< r< r= r+ H s
c C s t | dd dS )z Consume an iterable at C speed.r )maxlenN)r )iteratorr< r< r= consume\ s r3 )r, r- )r. r/ r0 r1 r2 )r3 r4 )r5 r6 r7 )F)rh )T)T)TNr NNN)N)fZ
__future__r collectionsr
contextlibrB ior Zloggingr r r? r rP rS r rH r r Zpip.exceptionsr Z
pip.compatr r r Z
pip.locationsr r r
r r r
Z pip._vendorr Zpip._vendor.six.movesr Zpip._vendor.sixr Zpip._vendor.retryingr r r __all__Z getLoggerr r r r r r r) r* bz2r9 r Zlzmar> r( r" r rQ r r rv r r r r r DEFAULT_BUFFER_SIZEr r r r r r r r r r r r r r r r! r r# r$ r% r& r r objectr r contextmanagerr) r' r* r+ r3 r< r< r< r= s
5%
+L!
_
__pycache__/deprecation.cpython-36.pyc 0000644 00000003255 14722165061 0013710 0 ustar 00 3
.
g @ s d Z ddlmZ ddlZddlZG dd deZG dd deZG dd d eZ G d
d d eeZ
G d d
d
eZ da dddZ
dd ZdS )zN
A module that implements tooling to enable easy warnings about deprecations.
)absolute_importNc @ s e Zd ZdS )PipDeprecationWarningN)__name__
__module__ __qualname__ r r !/usr/lib/python3.6/deprecation.pyr
s r c @ s e Zd ZdS )PendingN)r r r r r r r r s r c @ s e Zd ZdS )RemovedInPip10WarningN)r r r r r r r r
s r
c @ s e Zd ZdS )RemovedInPip11WarningN)r r r r r r r r s r c @ s e Zd ZdS )Python26DeprecationWarningN)r r r r r r r r s r c C sx |d k r$t d k rtt | ||||| nPt|trbtjd}d| }t|trV|j| qt|j| nt | ||||| d S )Nzpip.deprecationszDEPRECATION: %s)_warnings_showwarning
issubclassr loggingZ getLoggerr Zwarningerror)messagecategoryfilenamelinenofilelineZloggerZ log_messager r r _showwarning$ s
r c C s( t jdtdd td kr$t jatt _d S )NdefaultT)append)warnings simplefilterr r
showwarningr r r r r install_warning_loggerD s r )NN)__doc__Z
__future__r r r Warningr objectr r
r r r
r r r r r r s
__pycache__/build.cpython-36.pyc 0000644 00000002420 14722165061 0012503 0 ustar 00 3
.
g @ s< d dl mZ d dlZd dlZd dlmZ G dd deZdS ) )absolute_importN)rmtreec @ s6 e Zd Zd ddZdd Zdd Zdd Zd
d ZdS )
BuildDirectoryNc C sL |d kr|d krd}|d kr)format __class____name__r
)r r
r
r __repr__ s zBuildDirectory.__repr__c C s | j S )N)r
)r r
r
r __enter__" s zBuildDirectory.__enter__c C s | j d S )N)cleanup)r excvaluetbr
r
r __exit__% s zBuildDirectory.__exit__c C s | j rt| j d S )N)r r r
)r r
r
r r ( s zBuildDirectory.cleanup)NN)r
__module__ __qualname__r r r r r r
r
r
r r s
r ) Z
__future__r Zos.pathr r Z pip.utilsr objectr r
r
r
r s __pycache__/hashes.cpython-36.opt-1.pyc 0000644 00000006227 14722165061 0013627 0 ustar 00 3
.
g2 @ sz d dl mZ d dlZd dlmZmZmZ d dlmZ d dl m
Z
m Z m Z dZ
dddgZG d d
d
eZG d d d eZdS )
)absolute_importN) HashMismatch HashMissingInstallationError) read_chunks) iteritemsiterkeys
itervaluesZsha256Zsha384Zsha512c @ sJ e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dS )HasheszaA wrapper that builds multiple hashes at once and checks them against
known-good values
Nc C s |dkr i n|| _ dS )zo
:param hashes: A dict of algorithm names pointing to lists of allowed
hex digests
N)_allowed)selfhashes r /usr/lib/python3.6/hashes.py__init__ s zHashes.__init__c
C s i }xJt | jD ]<}ytj|||< W q ttfk
rJ td| Y qX qW x(|D ] }xt|D ]}|j| qdW qVW x*t |D ] \}}|j
| j| krdS qW | j | dS )zCheck good hashes against ones built from iterable of chunks of
data.
Raise HashMismatch if none match.
zUnknown hash name: %sN) r r hashlibnew
ValueError TypeErrorr r updater hexdigest_raise)r ZchunksgotsZ hash_namechunkhashZgotr r r check_against_chunks s
zHashes.check_against_chunksc C s t | j|d S )N)r r )r r r r r r 7 s z
Hashes._raisec C s | j t|S )zaCheck good hashes against a file-like object
Raise HashMismatch if none match.
)r r )r filer r r check_against_file: s zHashes.check_against_filec C s t |d }| j|S Q R X d S )Nrb)openr )r pathr r r r check_against_pathB s zHashes.check_against_pathc C s
t | jS )z,Return whether I know any known-good hashes.)boolr )r r r r __nonzero__F s zHashes.__nonzero__c C s | j S )N)r# )r r r r __bool__J s zHashes.__bool__)N) __name__
__module__ __qualname____doc__r r r r r! r# r$ r r r r r
s
r
c s( e Zd ZdZ fddZdd Z ZS )
MissingHasheszA workalike for Hashes used when we're missing a hash for a requirement
It computes the actual hash of the requirement and raises a HashMissing
exception showing it to the user.
c s t t| jtg id dS )z!Don't offer the ``hashes`` kwarg.)r
N)superr) r
FAVORITE_HASH)r ) __class__r r r U s zMissingHashes.__init__c C s t |t j d S )N)r r+ r )r r r r r r [ s zMissingHashes._raise)r% r& r' r( r r
__classcell__r r )r, r r) N s r) )Z
__future__r r Zpip.exceptionsr r r Z pip.utilsr Zpip._vendor.sixr r r r+ Z
STRONG_HASHESobjectr
r) r r r r s
: __pycache__/encoding.cpython-36.pyc 0000644 00000001747 14722165061 0013205 0 ustar 00 3
.
g @ sj d dl Z d dlZd dlZe jdfe jdfe jdfe jdfe jdfe jdfe j dfgZ
ej d Z d
d Z
dS ) Nutf8utf16zutf16-bezutf16-leutf32zutf32-bezutf32-les coding[:=]\s*([-\w.]+)c C s x0t D ](\}}| j|r| t|d j|S qW xV| jddd D ]@}|dd dkrFtj|rFtj|j d jd}| j|S qFW | jtj dS ) zCheck a bytes string for a BOM to correctly detect the encoding
Fallback to locale.getpreferredencoding(False) like open() on Python3N
r #asciiF)
BOMS
startswithlendecodesplit ENCODING_REsearchgroupslocalegetpreferredencoding)dataZbomencodingline r /usr/lib/python3.6/encoding.py auto_decode s
r )codecsr reBOM_UTF8 BOM_UTF16 BOM_UTF16_BE BOM_UTF16_LE BOM_UTF32 BOM_UTF32_BE BOM_UTF32_LEr
compiler r r r r r s
__pycache__/encoding.cpython-36.opt-1.pyc 0000644 00000001747 14722165061 0014144 0 ustar 00 3
.
g @ sj d dl Z d dlZd dlZe jdfe jdfe jdfe jdfe jdfe jdfe j dfgZ
ej d Z d
d Z
dS ) Nutf8utf16zutf16-bezutf16-leutf32zutf32-bezutf32-les coding[:=]\s*([-\w.]+)c C s x0t D ](\}}| j|r| t|d j|S qW xV| jddd D ]@}|dd dkrFtj|rFtj|j d jd}| j|S qFW | jtj dS ) zCheck a bytes string for a BOM to correctly detect the encoding
Fallback to locale.getpreferredencoding(False) like open() on Python3N
r #asciiF)
BOMS
startswithlendecodesplit ENCODING_REsearchgroupslocalegetpreferredencoding)dataZbomencodingline r /usr/lib/python3.6/encoding.py auto_decode s
r )codecsr reBOM_UTF8 BOM_UTF16 BOM_UTF16_BE BOM_UTF16_LE BOM_UTF32 BOM_UTF32_BE BOM_UTF32_LEr
compiler r r r r r s
__pycache__/ui.cpython-36.pyc 0000644 00000022534 14722165061 0012031 0 ustar 00 3
.
gM- @ s d dl mZ d dl mZ d dlZd dlZd dlmZmZmZ d dlZd dl Z d dl
Z
d dl m Z d dl
mZ d dlmZ d dlmZ d d lmZmZ d d
lmZmZmZ d d lmZ yd d lm Z W n e k
r dZ Y nX e
j e Z d
d Z!e!eeZ"G dd de#Z$G dd de#Z%G dd de#Z&G dd de&e$e%e"Z'G dd de&e$e%eeZ(e j)dd Z*G dd d e#Z+G d d d e#Z,G d d d e#Z-e j)d!d" Z.dS )# )absolute_import)divisionN)signalSIGINTdefault_int_handler)WINDOWS) format_size)get_indentation)six)BarIncrementalBar) WritelnMixin HIDE_CURSOR SHOW_CURSOR)Spinner)coloramac C s t | jdd }|s|S t | dtj t | dtj g}|tt | dg 7 }ytj j|j| W n tk
rv |S X | S d S )NencodingZ
empty_fillZfillphases)getattrfiler
Z text_typelistjoinencodeUnicodeEncodeError)Z preferredZfallbackr Z
characters r /usr/lib/python3.6/ui.py_select_progress_class s r c s4 e Zd ZdZ fddZ fddZdd Z ZS )InterruptibleMixina
Helper to ensure that self.finish() gets called on keyboard interrupt.
This allows downloads to be interrupted without leaving temporary state
(like hidden cursors) behind.
This class is similar to the progress library's existing SigIntMixin
helper, but as of version 1.2, that helper has the following problems:
1. It calls sys.exit().
2. It discards the existing SIGINT handler completely.
3. It leaves its own handler in place even after an uninterrupted finish,
which will have unexpected delayed effects if the user triggers an
unrelated keyboard interrupt some time after a progress-displaying
download has already completed, for example.
c s4 t t| j|| tt| j| _| jdkr0t| _dS )z=
Save the original SIGINT handler for later.
N)superr __init__r r
handle_sigintoriginal_handlerr )selfargskwargs) __class__r r r N s
zInterruptibleMixin.__init__c s t t| j tt| j dS )z
Restore the original SIGINT handler after finishing.
This should happen regardless of whether the progress display finishes
normally, or gets interrupted.
N)r r finishr r r! )r" )r% r r r& ^ s zInterruptibleMixin.finishc C s | j | j|| dS )z
Call self.finish() before delegating to the original SIGINT handler.
This handler should only be in place while the progress display is
active.
N)r& r! )r" Zsignumframer r r r h s z InterruptibleMixin.handle_sigint)__name__
__module__ __qualname____doc__r r& r
__classcell__r r )r% r r < s
r c sJ e Zd Z fddZedd Zedd Zedd Zd d
d Z Z S )
DownloadProgressMixinc s, t t| j|| dt d | j | _d S )N )r r- r r message)r" r# r$ )r% r r r u s z DownloadProgressMixin.__init__c C s
t | jS )N)r index)r" r r r
downloadedy s z DownloadProgressMixin.downloadedc C s | j dkrdS td| j d S )Ng z... z/s)Zavgr )r" r r r download_speed} s
z$DownloadProgressMixin.download_speedc C s | j rd| j S dS )Nzeta %s )ZetaZeta_td)r" r r r
pretty_eta s
z DownloadProgressMixin.pretty_etar3 c c s* x |D ]}|V | j | qW | j d S )N)nextr& )r" itnxr r r iter s
zDownloadProgressMixin.iter)r3 )
r( r) r* r propertyr2 r4 r6 r; r, r r )r% r r- s s
r- c s e Zd Z fddZ ZS ) WindowsMixinc s\ t r jrd _tt j|| t rXtrXtj j _ fdd j_ fdd j_ d S )NFc s j jj S )N)r wrappedisattyr )r" r r s z'WindowsMixin.__init__..c s j jj S )N)r r> flushr )r" r r r@ s )
r Z hide_cursorr r= r r Z AnsiToWin32r r? rA )r" r# r$ )r% )r" r r s
zWindowsMixin.__init__)r( r) r* r r, r r )r% r r= s r= c @ s e Zd ZejZdZdZdS )DownloadProgressBarz
%(percent)d%%z0%(downloaded)s %(download_speed)s %(pretty_eta)sN)r( r) r* sysstdoutr r0 suffixr r r r rB s rB c @ s& e Zd ZejZdZdd Zdd ZdS )DownloadProgressSpinnerz!%(downloaded)s %(download_speed)sc C s" t | dstj| j| _t| jS )N_phaser)hasattr itertoolscycler rG r7 )r" r r r
next_phase s
z"DownloadProgressSpinner.next_phasec C sN | j | }| j }| j| }dj||r*dnd||r6dnd|g}| j| d S )Nr5 r. )r0 rK rE r Zwriteln)r" r0 ZphaserE liner r r update s
z DownloadProgressSpinner.updateN) r( r) r* rC rD r rE rK rM r r r r rF s rF c c sR t r d V nB| j s$tj tjkr,d V n"| jt z
d V W d | jt X d S )N) r r? loggergetEffectiveLevelloggingINFOwriter r )r r r r
hidden_cursor s
rS c @ s$ e Zd Zdd Zdd Zdd ZdS ) RateLimiterc C s || _ d| _d S )Nr ) _min_update_interval_seconds _last_update)r" min_update_interval_secondsr r r r s zRateLimiter.__init__c C s t j }|| j }|| jkS )N)timerV rU )r" ZnowZdeltar r r ready s
zRateLimiter.readyc C s t j | _d S )N)rX rV )r" r r r reset s zRateLimiter.resetN)r( r) r* r rY rZ r r r r rT s rT c @ s. e Zd Zd ddZdd Zdd Zd
d ZdS )
InteractiveSpinnerN-\|/ ?c C s\ || _ |d krtj}|| _t|| _d| _tj|| _ | jj
dt | j d d| _ d S )NFr. z ... r )
_messagerC rD _filerT
_rate_limiter _finishedrI rJ _spin_cyclerR r _width)r" r0 r Z
spin_charsrW r r r r s
zInteractiveSpinner.__init__c C s^ | j s td| j }| jj|d| j | | jj| t|| _| jj | jj d S )Nr. ) ra AssertionErrorrc r_ rR lenrA r` rZ )r" statusZbackupr r r _write s
zInteractiveSpinner._writec C s, | j r
d S | jj sd S | jt| j d S )N)ra r` rY rh r7 rb )r" r r r spin s
zInteractiveSpinner.spinc C s4 | j r
d S | j| | jjd | jj d| _ d S )N
T)ra rh r_ rR rA )r" final_statusr r r r& s
zInteractiveSpinner.finish)Nr\ r] )r( r) r* r rh ri r& r r r r r[ s
r[ c @ s. e Zd Zd ddZdd Zdd Zdd Zd
S ) NonInteractiveSpinner< c C s$ || _ d| _t|| _| jd d S )NFZstarted)r^ ra rT r` _update)r" r0 rW r r r r * s
z NonInteractiveSpinner.__init__c C s* | j s t| jj tjd| j| d S )Nz%s: %s)ra re r` rZ rN infor^ )r" rg r r r rn 0 s
z NonInteractiveSpinner._updatec C s& | j r
d S | jj sd S | jd d S )Nzstill running...)ra r` rY rn )r" r r r ri 5 s
zNonInteractiveSpinner.spinc C s$ | j r
d S | jd|f d| _ d S )Nzfinished with status '%s'T)ra rn )r" rk r r r r& < s z NonInteractiveSpinner.finishN)rm )r( r) r* r rn ri r& r r r r rl ) s
rl c c s t jj r"tj tjkr"t| }nt| }y t t j |V W d Q R X W n> t
k
rj |j d Y n* t k
r |j d Y n X |j d d S )NZcancelederrordone)
rC rD r? rN rO rP rQ r[ rl rS KeyboardInterruptr& Exception)r0 Zspinnerr r r open_spinnerC s
rt )/Z
__future__r r rI rC r r r rX
contextlibrP Z
pip.compatr Z pip.utilsr Zpip.utils.loggingr Z pip._vendorr
Zpip._vendor.progress.barr r Z pip._vendor.progress.helpersr
r r Z pip._vendor.progress.spinnerr r rs Z getLoggerr( rN r Z_BaseBarobjectr r- r= rB rF contextmanagerrS rT r[ rl rt r r r r sB
7
!0 __pycache__/appdirs.cpython-36.opt-1.pyc 0000644 00000017002 14722165061 0014007 0 ustar 00 3
.
gk" @ s d Z ddlmZ ddlZddlZddlmZmZ ddlm Z m
Z
dd Z dd d
Z dd d
Z
dd Zdd Zdd ZeryddlZeZW n ek
r eZY nX dd ZdS )zd
This code was taken from https://github.com/ActiveState/appdirs and modified
to suit our purposes.
)absolute_importN)WINDOWS
expanduser)PY2 text_typec C s t r
Unix: ~/.cache/ (XDG default)
Windows: C:\Users\\AppData\Local\\Cache
On Windows the only suggestion in the MSDN docs is that local settings go
in the `CSIDL_LOCAL_APPDATA` directory. This is identical to the
non-roaming app data dir (the default returned by `user_data_dir`). Apps
typically put cache data somewhere *under* the given dir here. Some
examples:
...\Mozilla\Firefox\Profiles\\Cache
...\Acme\SuperApp\Cache\1.0
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value.
CSIDL_LOCAL_APPDATAZCachedarwinz~/Library/CachesZXDG_CACHE_HOMEz~/.cache)r ospathnormpath_get_win_folderr
isinstancer _win_path_to_bytesjoinsysplatformr getenv)appnamer
r /usr/lib/python3.6/appdirs.pyuser_cache_dir s
r Fc C sh t r,|r dpd}tjjtjjt|| }n8tjdkrJtjjtd| }ntjjtj dtd| }|S )aS
Return full path to the user-specific data dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default False) can be set True to use the Windows
roaming appdata directory. That means that for users on a Windows
network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: ~/Library/Application Support/
Unix: ~/.local/share/ # or in
$XDG_DATA_HOME, if defined
Win XP (not roaming): C:\Documents and Settings\\ ...
...Application Data\
Win XP (roaming): C:\Documents and Settings\\Local ...
...Settings\Application Data\
Win 7 (not roaming): C:\Users\\AppData\Local\
Win 7 (roaming): C:\Users\\AppData\Roaming\
For Unix, we follow the XDG spec and support $XDG_DATA_HOME.
That means, by default "~/.local/share/".
CSIDL_APPDATAr r z ~/Library/Application Support/Z
XDG_DATA_HOMEz~/.local/share)
r r r
r r r r r r r )r roamingconstr
r r r
user_data_dir> s
r Tc C sH t rt| |d}n2tjdkr&t| }n tjdtd}tjj|| }|S )ar Return full path to the user-specific config dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default True) can be set False to not use the
Windows roaming appdata directory. That means that for users on a
Windows network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: same as user_data_dir
Unix: ~/.config/
Win *: same as user_data_dir
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
That means, by default "~/.config/".
)r r ZXDG_CONFIG_HOMEz ~/.config) r r r r r r r r
r )r r r
r r r user_config_dirj s
r c s t r&tjjtd}tjj| g}nVtjdkrBtjjd g}n:tjdd}|rn fdd|j tj
D }ng }|j d |S ) a Return a list of potential user-shared config dirs for this application.
"appname" is the name of application.
Typical user config directories are:
macOS: /Library/Application Support//
Unix: /etc or $XDG_CONFIG_DIRS[i]// for each value in
$XDG_CONFIG_DIRS
Win XP: C:\Documents and Settings\All Users\Application ...
...Data\ Vista: (Fail! "C:\ProgramData" is a hidden *system* directory
on Vista.)
Win 7: Hidden, but writeable on Win 7:
C:\ProgramData\ CSIDL_COMMON_APPDATAr z /Library/Application SupportZXDG_CONFIG_DIRSz/etc/xdgc s g | ]}t jjt| qS r )r r
r r ).0x)r r r
s z$site_config_dirs..z/etc) r r r
r r r r r r splitpathsepappend)r r
ZpathlistZxdg_config_dirsr )r r site_config_dirs s
r# c C s: ddl }dddd| }|j|jd}|j||\}}|S )z
This is a fallback technique at best. I'm not sure if using the
registry for this guarantees us the correct answer for all CSIDL_*
names.
r NZAppDatazCommon AppDataz
Local AppData)r r r z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)_winregOpenKeyHKEY_CURRENT_USERZ QueryValueEx)
csidl_namer$ Zshell_folder_namekeyZ directoryZ_typer r r _get_win_folder_from_registry s r) c C s dddd| }t jd}t jjjd |d d| d}x |D ]}t|dkr:d }P q:W |rzt jd}t jjj|j|drz|}|jS )
N # )r r r i r F T) ctypesZcreate_unicode_bufferZwindllZshell32ZSHGetFolderPathWordZkernel32ZGetShortPathNameWvalue)r' Z csidl_constZbufZ
has_high_charcZbuf2r r r _get_win_folder_with_ctypes s
r2 c
C s6 x0dD ](}y
| j |S ttfk
r, Y qX qW | S )a Encode Windows paths to bytes. Only used on Python 2.
Motivation is to be consistent with other operating systems where paths
are also returned as bytes. This avoids problems mixing bytes and Unicode
elsewhere in the codebase. For more details and discussion see
.
If encoding using ASCII and MBCS fails, return the original Unicode path.
ASCIIMBCS)r3 r4 )encodeUnicodeEncodeError LookupError)r
encodingr r r r s
r )F)T)__doc__Z
__future__r r r Z
pip.compatr r Zpip._vendor.sixr r r r r r# r) r2 r. r ImportErrorr r r r r s$ 0
,
!(
build.py 0000644 00000002440 14722165061 0006221 0 ustar 00 from __future__ import absolute_import
import os.path
import tempfile
from pip.utils import rmtree
class BuildDirectory(object):
def __init__(self, name=None, delete=None):
# If we were not given an explicit directory, and we were not given an
# explicit delete option, then we'll default to deleting.
if name is None and delete is None:
delete = True
if name is None:
# We realpath here because some systems have their default tmpdir
# symlinked to another directory. This tends to confuse build
# scripts, so we canonicalize the path by traversing potential
# symlinks here.
name = os.path.realpath(tempfile.mkdtemp(prefix="pip-build-"))
# If we were not given an explicit directory, and we were not given
# an explicit delete option, then we'll default to deleting.
if delete is None:
delete = True
self.name = name
self.delete = delete
def __repr__(self):
return "<{} {!r}>".format(self.__class__.__name__, self.name)
def __enter__(self):
return self.name
def __exit__(self, exc, value, tb):
self.cleanup()
def cleanup(self):
if self.delete:
rmtree(self.name)
glibc.py 0000644 00000005573 14722165061 0006214 0 ustar 00 from __future__ import absolute_import
import re
import ctypes
import platform
import warnings
def glibc_version_string():
"Returns glibc version string, or None if not using glibc."
# ctypes.CDLL(None) internally calls dlopen(NULL), and as the dlopen
# manpage says, "If filename is NULL, then the returned handle is for the
# main program". This way we can let the linker do the work to figure out
# which libc our process is actually using.
process_namespace = ctypes.CDLL(None)
try:
gnu_get_libc_version = process_namespace.gnu_get_libc_version
except AttributeError:
# Symbol doesn't exist -> therefore, we are not linked to
# glibc.
return None
# Call gnu_get_libc_version, which returns a string like "2.5"
gnu_get_libc_version.restype = ctypes.c_char_p
version_str = gnu_get_libc_version()
# py2 / py3 compatibility:
if not isinstance(version_str, str):
version_str = version_str.decode("ascii")
return version_str
# Separated out from have_compatible_glibc for easier unit testing
def check_glibc_version(version_str, required_major, minimum_minor):
# Parse string and check against requested version.
#
# We use a regexp instead of str.split because we want to discard any
# random junk that might come after the minor version -- this might happen
# in patched/forked versions of glibc (e.g. Linaro's version of glibc
# uses version strings like "2.20-2014.11"). See gh-3588.
m = re.match(r"(?P[0-9]+)\.(?P[0-9]+)", version_str)
if not m:
warnings.warn("Expected glibc version with 2 components major.minor,"
" got: %s" % version_str, RuntimeWarning)
return False
return (int(m.group("major")) == required_major and
int(m.group("minor")) >= minimum_minor)
def have_compatible_glibc(required_major, minimum_minor):
version_str = glibc_version_string()
if version_str is None:
return False
return check_glibc_version(version_str, required_major, minimum_minor)
# platform.libc_ver regularly returns completely nonsensical glibc
# versions. E.g. on my computer, platform says:
#
# ~$ python2.7 -c 'import platform; print(platform.libc_ver())'
# ('glibc', '2.7')
# ~$ python3.5 -c 'import platform; print(platform.libc_ver())'
# ('glibc', '2.9')
#
# But the truth is:
#
# ~$ ldd --version
# ldd (Debian GLIBC 2.22-11) 2.22
#
# This is unfortunate, because it means that the linehaul data on libc
# versions that was generated by pip 8.1.2 and earlier is useless and
# misleading. Solution: instead of using platform, use our code that actually
# works.
def libc_ver():
glibc_version = glibc_version_string()
if glibc_version is None:
# For non-glibc platforms, fall back on platform.libc_ver
return platform.libc_ver()
else:
return ("glibc", glibc_version)
appdirs.py 0000644 00000021153 14722165061 0006566 0 ustar 00 """
This code was taken from https://github.com/ActiveState/appdirs and modified
to suit our purposes.
"""
from __future__ import absolute_import
import os
import sys
from pip.compat import WINDOWS, expanduser
from pip._vendor.six import PY2, text_type
def user_cache_dir(appname):
r"""
Return full path to the user-specific cache dir for this application.
"appname" is the name of application.
Typical user cache directories are:
macOS: ~/Library/Caches/
Unix: ~/.cache/ (XDG default)
Windows: C:\Users\\AppData\Local\\Cache
On Windows the only suggestion in the MSDN docs is that local settings go
in the `CSIDL_LOCAL_APPDATA` directory. This is identical to the
non-roaming app data dir (the default returned by `user_data_dir`). Apps
typically put cache data somewhere *under* the given dir here. Some
examples:
...\Mozilla\Firefox\Profiles\\Cache
...\Acme\SuperApp\Cache\1.0
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value.
"""
if WINDOWS:
# Get the base path
path = os.path.normpath(_get_win_folder("CSIDL_LOCAL_APPDATA"))
# When using Python 2, return paths as bytes on Windows like we do on
# other operating systems. See helper function docs for more details.
if PY2 and isinstance(path, text_type):
path = _win_path_to_bytes(path)
# Add our app name and Cache directory to it
path = os.path.join(path, appname, "Cache")
elif sys.platform == "darwin":
# Get the base path
path = expanduser("~/Library/Caches")
# Add our app name to it
path = os.path.join(path, appname)
else:
# Get the base path
path = os.getenv("XDG_CACHE_HOME", expanduser("~/.cache"))
# Add our app name to it
path = os.path.join(path, appname)
return path
def user_data_dir(appname, roaming=False):
"""
Return full path to the user-specific data dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default False) can be set True to use the Windows
roaming appdata directory. That means that for users on a Windows
network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: ~/Library/Application Support/
Unix: ~/.local/share/ # or in
$XDG_DATA_HOME, if defined
Win XP (not roaming): C:\Documents and Settings\\ ...
...Application Data\
Win XP (roaming): C:\Documents and Settings\\Local ...
...Settings\Application Data\
Win 7 (not roaming): C:\\Users\\AppData\Local\
Win 7 (roaming): C:\\Users\\AppData\Roaming\
For Unix, we follow the XDG spec and support $XDG_DATA_HOME.
That means, by default "~/.local/share/".
"""
if WINDOWS:
const = roaming and "CSIDL_APPDATA" or "CSIDL_LOCAL_APPDATA"
path = os.path.join(os.path.normpath(_get_win_folder(const)), appname)
elif sys.platform == "darwin":
path = os.path.join(
expanduser('~/Library/Application Support/'),
appname,
)
else:
path = os.path.join(
os.getenv('XDG_DATA_HOME', expanduser("~/.local/share")),
appname,
)
return path
def user_config_dir(appname, roaming=True):
"""Return full path to the user-specific config dir for this application.
"appname" is the name of application.
If None, just the system directory is returned.
"roaming" (boolean, default True) can be set False to not use the
Windows roaming appdata directory. That means that for users on a
Windows network setup for roaming profiles, this user data will be
sync'd on login. See
for a discussion of issues.
Typical user data directories are:
macOS: same as user_data_dir
Unix: ~/.config/
Win *: same as user_data_dir
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME.
That means, by default "~/.config/".
"""
if WINDOWS:
path = user_data_dir(appname, roaming=roaming)
elif sys.platform == "darwin":
path = user_data_dir(appname)
else:
path = os.getenv('XDG_CONFIG_HOME', expanduser("~/.config"))
path = os.path.join(path, appname)
return path
# for the discussion regarding site_config_dirs locations
# see
def site_config_dirs(appname):
"""Return a list of potential user-shared config dirs for this application.
"appname" is the name of application.
Typical user config directories are:
macOS: /Library/Application Support//
Unix: /etc or $XDG_CONFIG_DIRS[i]// for each value in
$XDG_CONFIG_DIRS
Win XP: C:\Documents and Settings\All Users\Application ...
...Data\\
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory
on Vista.)
Win 7: Hidden, but writeable on Win 7:
C:\ProgramData\\
"""
if WINDOWS:
path = os.path.normpath(_get_win_folder("CSIDL_COMMON_APPDATA"))
pathlist = [os.path.join(path, appname)]
elif sys.platform == 'darwin':
pathlist = [os.path.join('/Library/Application Support', appname)]
else:
# try looking in $XDG_CONFIG_DIRS
xdg_config_dirs = os.getenv('XDG_CONFIG_DIRS', '/etc/xdg')
if xdg_config_dirs:
pathlist = [
os.path.join(expanduser(x), appname)
for x in xdg_config_dirs.split(os.pathsep)
]
else:
pathlist = []
# always look in /etc directly as well
pathlist.append('/etc')
return pathlist
# -- Windows support functions --
def _get_win_folder_from_registry(csidl_name):
"""
This is a fallback technique at best. I'm not sure if using the
registry for this guarantees us the correct answer for all CSIDL_*
names.
"""
import _winreg
shell_folder_name = {
"CSIDL_APPDATA": "AppData",
"CSIDL_COMMON_APPDATA": "Common AppData",
"CSIDL_LOCAL_APPDATA": "Local AppData",
}[csidl_name]
key = _winreg.OpenKey(
_winreg.HKEY_CURRENT_USER,
r"Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders"
)
directory, _type = _winreg.QueryValueEx(key, shell_folder_name)
return directory
def _get_win_folder_with_ctypes(csidl_name):
csidl_const = {
"CSIDL_APPDATA": 26,
"CSIDL_COMMON_APPDATA": 35,
"CSIDL_LOCAL_APPDATA": 28,
}[csidl_name]
buf = ctypes.create_unicode_buffer(1024)
ctypes.windll.shell32.SHGetFolderPathW(None, csidl_const, None, 0, buf)
# Downgrade to short path name if have highbit chars. See
# .
has_high_char = False
for c in buf:
if ord(c) > 255:
has_high_char = True
break
if has_high_char:
buf2 = ctypes.create_unicode_buffer(1024)
if ctypes.windll.kernel32.GetShortPathNameW(buf.value, buf2, 1024):
buf = buf2
return buf.value
if WINDOWS:
try:
import ctypes
_get_win_folder = _get_win_folder_with_ctypes
except ImportError:
_get_win_folder = _get_win_folder_from_registry
def _win_path_to_bytes(path):
"""Encode Windows paths to bytes. Only used on Python 2.
Motivation is to be consistent with other operating systems where paths
are also returned as bytes. This avoids problems mixing bytes and Unicode
elsewhere in the codebase. For more details and discussion see
.
If encoding using ASCII and MBCS fails, return the original Unicode path.
"""
for encoding in ('ASCII', 'MBCS'):
try:
return path.encode(encoding)
except (UnicodeEncodeError, LookupError):
pass
return path
encoding.py 0000644 00000001713 14722165061 0006712 0 ustar 00 import codecs
import locale
import re
BOMS = [
(codecs.BOM_UTF8, 'utf8'),
(codecs.BOM_UTF16, 'utf16'),
(codecs.BOM_UTF16_BE, 'utf16-be'),
(codecs.BOM_UTF16_LE, 'utf16-le'),
(codecs.BOM_UTF32, 'utf32'),
(codecs.BOM_UTF32_BE, 'utf32-be'),
(codecs.BOM_UTF32_LE, 'utf32-le'),
]
ENCODING_RE = re.compile(b'coding[:=]\s*([-\w.]+)')
def auto_decode(data):
"""Check a bytes string for a BOM to correctly detect the encoding
Fallback to locale.getpreferredencoding(False) like open() on Python3"""
for bom, encoding in BOMS:
if data.startswith(bom):
return data[len(bom):].decode(encoding)
# Lets check the first two lines as in PEP263
for line in data.split(b'\n')[:2]:
if line[0:1] == b'#' and ENCODING_RE.search(line):
encoding = ENCODING_RE.search(line).groups()[0].decode('ascii')
return data.decode(encoding)
return data.decode(locale.getpreferredencoding(False))
filesystem.py 0000644 00000001603 14722165061 0007306 0 ustar 00 import os
import os.path
from pip.compat import get_path_uid
def check_path_owner(path):
# If we don't have a way to check the effective uid of this process, then
# we'll just assume that we own the directory.
if not hasattr(os, "geteuid"):
return True
previous = None
while path != previous:
if os.path.lexists(path):
# Check if path is writable by current user.
if os.geteuid() == 0:
# Special handling for root user in order to handle properly
# cases where users use sudo without -H flag.
try:
path_uid = get_path_uid(path)
except OSError:
return False
return path_uid == 0
else:
return os.access(path, os.W_OK)
else:
previous, path = path, os.path.dirname(path)
packaging.py 0000644 00000004040 14722165061 0007044 0 ustar 00 from __future__ import absolute_import
from email.parser import FeedParser
import logging
import sys
from pip._vendor.packaging import specifiers
from pip._vendor.packaging import version
from pip._vendor import pkg_resources
from pip import exceptions
logger = logging.getLogger(__name__)
def check_requires_python(requires_python):
"""
Check if the python version in use match the `requires_python` specifier.
Returns `True` if the version of python in use matches the requirement.
Returns `False` if the version of python in use does not matches the
requirement.
Raises an InvalidSpecifier if `requires_python` have an invalid format.
"""
if requires_python is None:
# The package provides no information
return True
requires_python_specifier = specifiers.SpecifierSet(requires_python)
# We only use major.minor.micro
python_version = version.parse('.'.join(map(str, sys.version_info[:3])))
return python_version in requires_python_specifier
def get_metadata(dist):
if (isinstance(dist, pkg_resources.DistInfoDistribution) and
dist.has_metadata('METADATA')):
return dist.get_metadata('METADATA')
elif dist.has_metadata('PKG-INFO'):
return dist.get_metadata('PKG-INFO')
def check_dist_requires_python(dist):
metadata = get_metadata(dist)
feed_parser = FeedParser()
feed_parser.feed(metadata)
pkg_info_dict = feed_parser.close()
requires_python = pkg_info_dict.get('Requires-Python')
try:
if not check_requires_python(requires_python):
raise exceptions.UnsupportedPythonVersion(
"%s requires Python '%s' but the running Python is %s" % (
dist.project_name,
requires_python,
'.'.join(map(str, sys.version_info[:3])),)
)
except specifiers.InvalidSpecifier as e:
logger.warning(
"Package %s has an invalid Requires-Python entry %s - %s" % (
dist.project_name, requires_python, e))
return
setuptools_build.py 0000644 00000000426 14722165061 0010524 0 ustar 00 # Shim to wrap setup.py invocation with setuptools
SETUPTOOLS_SHIM = (
"import setuptools, tokenize;__file__=%r;"
"f=getattr(tokenize, 'open', open)(__file__);"
"code=f.read().replace('\\r\\n', '\\n');"
"f.close();"
"exec(compile(code, __file__, 'exec'))"
)
logging.py 0000644 00000006377 14722165061 0006565 0 ustar 00 from __future__ import absolute_import
import contextlib
import logging
import logging.handlers
import os
try:
import threading
except ImportError:
import dummy_threading as threading
from pip.compat import WINDOWS
from pip.utils import ensure_dir
try:
from pip._vendor import colorama
# Lots of different errors can come from this, including SystemError and
# ImportError.
except Exception:
colorama = None
_log_state = threading.local()
_log_state.indentation = 0
@contextlib.contextmanager
def indent_log(num=2):
"""
A context manager which will cause the log output to be indented for any
log messages emitted inside it.
"""
_log_state.indentation += num
try:
yield
finally:
_log_state.indentation -= num
def get_indentation():
return getattr(_log_state, 'indentation', 0)
class IndentingFormatter(logging.Formatter):
def format(self, record):
"""
Calls the standard formatter, but will indent all of the log messages
by our current indentation level.
"""
formatted = logging.Formatter.format(self, record)
formatted = "".join([
(" " * get_indentation()) + line
for line in formatted.splitlines(True)
])
return formatted
def _color_wrap(*colors):
def wrapped(inp):
return "".join(list(colors) + [inp, colorama.Style.RESET_ALL])
return wrapped
class ColorizedStreamHandler(logging.StreamHandler):
# Don't build up a list of colors if we don't have colorama
if colorama:
COLORS = [
# This needs to be in order from highest logging level to lowest.
(logging.ERROR, _color_wrap(colorama.Fore.RED)),
(logging.WARNING, _color_wrap(colorama.Fore.YELLOW)),
]
else:
COLORS = []
def __init__(self, stream=None):
logging.StreamHandler.__init__(self, stream)
if WINDOWS and colorama:
self.stream = colorama.AnsiToWin32(self.stream)
def should_color(self):
# Don't colorize things if we do not have colorama
if not colorama:
return False
real_stream = (
self.stream if not isinstance(self.stream, colorama.AnsiToWin32)
else self.stream.wrapped
)
# If the stream is a tty we should color it
if hasattr(real_stream, "isatty") and real_stream.isatty():
return True
# If we have an ASNI term we should color it
if os.environ.get("TERM") == "ANSI":
return True
# If anything else we should not color it
return False
def format(self, record):
msg = logging.StreamHandler.format(self, record)
if self.should_color():
for level, color in self.COLORS:
if record.levelno >= level:
msg = color(msg)
break
return msg
class BetterRotatingFileHandler(logging.handlers.RotatingFileHandler):
def _open(self):
ensure_dir(os.path.dirname(self.baseFilename))
return logging.handlers.RotatingFileHandler._open(self)
class MaxLevelFilter(logging.Filter):
def __init__(self, level):
self.level = level
def filter(self, record):
return record.levelno < self.level
deprecation.py 0000644 00000004270 14722165061 0007422 0 ustar 00 """
A module that implements tooling to enable easy warnings about deprecations.
"""
from __future__ import absolute_import
import logging
import warnings
class PipDeprecationWarning(Warning):
pass
class Pending(object):
pass
class RemovedInPip10Warning(PipDeprecationWarning):
pass
class RemovedInPip11Warning(PipDeprecationWarning, Pending):
pass
class Python26DeprecationWarning(PipDeprecationWarning):
pass
# Warnings <-> Logging Integration
_warnings_showwarning = None
def _showwarning(message, category, filename, lineno, file=None, line=None):
if file is not None:
if _warnings_showwarning is not None:
_warnings_showwarning(
message, category, filename, lineno, file, line,
)
else:
if issubclass(category, PipDeprecationWarning):
# We use a specially named logger which will handle all of the
# deprecation messages for pip.
logger = logging.getLogger("pip.deprecations")
# This is purposely using the % formatter here instead of letting
# the logging module handle the interpolation. This is because we
# want it to appear as if someone typed this entire message out.
log_message = "DEPRECATION: %s" % message
# PipDeprecationWarnings that are Pending still have at least 2
# versions to go until they are removed so they can just be
# warnings. Otherwise, they will be removed in the very next
# version of pip. We want these to be more obvious so we use the
# ERROR logging level.
if issubclass(category, Pending):
logger.warning(log_message)
else:
logger.error(log_message)
else:
_warnings_showwarning(
message, category, filename, lineno, file, line,
)
def install_warning_logger():
# Enable our Deprecation Warnings
warnings.simplefilter("default", PipDeprecationWarning, append=True)
global _warnings_showwarning
if _warnings_showwarning is None:
_warnings_showwarning = warnings.showwarning
warnings.showwarning = _showwarning
ui.py 0000644 00000026515 14722165061 0005550 0 ustar 00 from __future__ import absolute_import
from __future__ import division
import itertools
import sys
from signal import signal, SIGINT, default_int_handler
import time
import contextlib
import logging
from pip.compat import WINDOWS
from pip.utils import format_size
from pip.utils.logging import get_indentation
from pip._vendor import six
from pip._vendor.progress.bar import Bar, IncrementalBar
from pip._vendor.progress.helpers import (WritelnMixin,
HIDE_CURSOR, SHOW_CURSOR)
from pip._vendor.progress.spinner import Spinner
try:
from pip._vendor import colorama
# Lots of different errors can come from this, including SystemError and
# ImportError.
except Exception:
colorama = None
logger = logging.getLogger(__name__)
def _select_progress_class(preferred, fallback):
encoding = getattr(preferred.file, "encoding", None)
# If we don't know what encoding this file is in, then we'll just assume
# that it doesn't support unicode and use the ASCII bar.
if not encoding:
return fallback
# Collect all of the possible characters we want to use with the preferred
# bar.
characters = [
getattr(preferred, "empty_fill", six.text_type()),
getattr(preferred, "fill", six.text_type()),
]
characters += list(getattr(preferred, "phases", []))
# Try to decode the characters we're using for the bar using the encoding
# of the given file, if this works then we'll assume that we can use the
# fancier bar and if not we'll fall back to the plaintext bar.
try:
six.text_type().join(characters).encode(encoding)
except UnicodeEncodeError:
return fallback
else:
return preferred
_BaseBar = _select_progress_class(IncrementalBar, Bar)
class InterruptibleMixin(object):
"""
Helper to ensure that self.finish() gets called on keyboard interrupt.
This allows downloads to be interrupted without leaving temporary state
(like hidden cursors) behind.
This class is similar to the progress library's existing SigIntMixin
helper, but as of version 1.2, that helper has the following problems:
1. It calls sys.exit().
2. It discards the existing SIGINT handler completely.
3. It leaves its own handler in place even after an uninterrupted finish,
which will have unexpected delayed effects if the user triggers an
unrelated keyboard interrupt some time after a progress-displaying
download has already completed, for example.
"""
def __init__(self, *args, **kwargs):
"""
Save the original SIGINT handler for later.
"""
super(InterruptibleMixin, self).__init__(*args, **kwargs)
self.original_handler = signal(SIGINT, self.handle_sigint)
# If signal() returns None, the previous handler was not installed from
# Python, and we cannot restore it. This probably should not happen,
# but if it does, we must restore something sensible instead, at least.
# The least bad option should be Python's default SIGINT handler, which
# just raises KeyboardInterrupt.
if self.original_handler is None:
self.original_handler = default_int_handler
def finish(self):
"""
Restore the original SIGINT handler after finishing.
This should happen regardless of whether the progress display finishes
normally, or gets interrupted.
"""
super(InterruptibleMixin, self).finish()
signal(SIGINT, self.original_handler)
def handle_sigint(self, signum, frame):
"""
Call self.finish() before delegating to the original SIGINT handler.
This handler should only be in place while the progress display is
active.
"""
self.finish()
self.original_handler(signum, frame)
class DownloadProgressMixin(object):
def __init__(self, *args, **kwargs):
super(DownloadProgressMixin, self).__init__(*args, **kwargs)
self.message = (" " * (get_indentation() + 2)) + self.message
@property
def downloaded(self):
return format_size(self.index)
@property
def download_speed(self):
# Avoid zero division errors...
if self.avg == 0.0:
return "..."
return format_size(1 / self.avg) + "/s"
@property
def pretty_eta(self):
if self.eta:
return "eta %s" % self.eta_td
return ""
def iter(self, it, n=1):
for x in it:
yield x
self.next(n)
self.finish()
class WindowsMixin(object):
def __init__(self, *args, **kwargs):
# The Windows terminal does not support the hide/show cursor ANSI codes
# even with colorama. So we'll ensure that hide_cursor is False on
# Windows.
# This call neds to go before the super() call, so that hide_cursor
# is set in time. The base progress bar class writes the "hide cursor"
# code to the terminal in its init, so if we don't set this soon
# enough, we get a "hide" with no corresponding "show"...
if WINDOWS and self.hide_cursor:
self.hide_cursor = False
super(WindowsMixin, self).__init__(*args, **kwargs)
# Check if we are running on Windows and we have the colorama module,
# if we do then wrap our file with it.
if WINDOWS and colorama:
self.file = colorama.AnsiToWin32(self.file)
# The progress code expects to be able to call self.file.isatty()
# but the colorama.AnsiToWin32() object doesn't have that, so we'll
# add it.
self.file.isatty = lambda: self.file.wrapped.isatty()
# The progress code expects to be able to call self.file.flush()
# but the colorama.AnsiToWin32() object doesn't have that, so we'll
# add it.
self.file.flush = lambda: self.file.wrapped.flush()
class DownloadProgressBar(WindowsMixin, InterruptibleMixin,
DownloadProgressMixin, _BaseBar):
file = sys.stdout
message = "%(percent)d%%"
suffix = "%(downloaded)s %(download_speed)s %(pretty_eta)s"
class DownloadProgressSpinner(WindowsMixin, InterruptibleMixin,
DownloadProgressMixin, WritelnMixin, Spinner):
file = sys.stdout
suffix = "%(downloaded)s %(download_speed)s"
def next_phase(self):
if not hasattr(self, "_phaser"):
self._phaser = itertools.cycle(self.phases)
return next(self._phaser)
def update(self):
message = self.message % self
phase = self.next_phase()
suffix = self.suffix % self
line = ''.join([
message,
" " if message else "",
phase,
" " if suffix else "",
suffix,
])
self.writeln(line)
################################################################
# Generic "something is happening" spinners
#
# We don't even try using progress.spinner.Spinner here because it's actually
# simpler to reimplement from scratch than to coerce their code into doing
# what we need.
################################################################
@contextlib.contextmanager
def hidden_cursor(file):
# The Windows terminal does not support the hide/show cursor ANSI codes,
# even via colorama. So don't even try.
if WINDOWS:
yield
# We don't want to clutter the output with control characters if we're
# writing to a file, or if the user is running with --quiet.
# See https://github.com/pypa/pip/issues/3418
elif not file.isatty() or logger.getEffectiveLevel() > logging.INFO:
yield
else:
file.write(HIDE_CURSOR)
try:
yield
finally:
file.write(SHOW_CURSOR)
class RateLimiter(object):
def __init__(self, min_update_interval_seconds):
self._min_update_interval_seconds = min_update_interval_seconds
self._last_update = 0
def ready(self):
now = time.time()
delta = now - self._last_update
return delta >= self._min_update_interval_seconds
def reset(self):
self._last_update = time.time()
class InteractiveSpinner(object):
def __init__(self, message, file=None, spin_chars="-\\|/",
# Empirically, 8 updates/second looks nice
min_update_interval_seconds=0.125):
self._message = message
if file is None:
file = sys.stdout
self._file = file
self._rate_limiter = RateLimiter(min_update_interval_seconds)
self._finished = False
self._spin_cycle = itertools.cycle(spin_chars)
self._file.write(" " * get_indentation() + self._message + " ... ")
self._width = 0
def _write(self, status):
assert not self._finished
# Erase what we wrote before by backspacing to the beginning, writing
# spaces to overwrite the old text, and then backspacing again
backup = "\b" * self._width
self._file.write(backup + " " * self._width + backup)
# Now we have a blank slate to add our status
self._file.write(status)
self._width = len(status)
self._file.flush()
self._rate_limiter.reset()
def spin(self):
if self._finished:
return
if not self._rate_limiter.ready():
return
self._write(next(self._spin_cycle))
def finish(self, final_status):
if self._finished:
return
self._write(final_status)
self._file.write("\n")
self._file.flush()
self._finished = True
# Used for dumb terminals, non-interactive installs (no tty), etc.
# We still print updates occasionally (once every 60 seconds by default) to
# act as a keep-alive for systems like Travis-CI that take lack-of-output as
# an indication that a task has frozen.
class NonInteractiveSpinner(object):
def __init__(self, message, min_update_interval_seconds=60):
self._message = message
self._finished = False
self._rate_limiter = RateLimiter(min_update_interval_seconds)
self._update("started")
def _update(self, status):
assert not self._finished
self._rate_limiter.reset()
logger.info("%s: %s", self._message, status)
def spin(self):
if self._finished:
return
if not self._rate_limiter.ready():
return
self._update("still running...")
def finish(self, final_status):
if self._finished:
return
self._update("finished with status '%s'" % (final_status,))
self._finished = True
@contextlib.contextmanager
def open_spinner(message):
# Interactive spinner goes directly to sys.stdout rather than being routed
# through the logging system, but it acts like it has level INFO,
# i.e. it's only displayed if we're at level INFO or better.
# Non-interactive spinner goes through the logging system, so it is always
# in sync with logging configuration.
if sys.stdout.isatty() and logger.getEffectiveLevel() <= logging.INFO:
spinner = InteractiveSpinner(message)
else:
spinner = NonInteractiveSpinner(message)
try:
with hidden_cursor(sys.stdout):
yield spinner
except KeyboardInterrupt:
spinner.finish("canceled")
raise
except Exception:
spinner.finish("error")
raise
else:
spinner.finish("done")
FileUtils.pyo 0000644 00000027746 14722167475 0007234 0 ustar 00
.t_c @ s' d Z d d l m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l m Z d d l
m
Z
m Z e j d d e f d YZ d
e f d YZ d e f d
YZ d e f d YZ d e f d YZ d S( s
FileUtils - Provides dmmgmnt file-related capabilities.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/FileUtils.py#1 $
i( t print_functionNi ( t Command( t Timeoutt TimeoutErrort utilst FileBasec B sh e Z d Z e j d Z e d Z d Z d Z d Z
e d Z e j d Z RS( s The FileBase object; provides basic file control.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileBasec C s | j S( N( t _FileBase__filePath( t self( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt path: s c O sA t t | j t j j | | _ | j d d | _ d S( s:
Arguments:
None
Returns:
Nothing
t fdN(
t superR t __init__t osR t realpathR t gett Nonet
_FileBase__fd( R t filePatht argst kwargs( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR A s c C s | S( N( ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __enter__M s c C s t S( N( t False( R t
exceptionTypet exceptionValuet traceback( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __exit__Q s c C s | j S( N( R ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt _fdX s c C s
| | _ d S( N( R ( R t value( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR _ s (
t __name__t
__module__t __doc__t loggingt getLoggert logt propertyR R R R R t setter( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR - s t FileTouchc B s8 e Z d Z e j d Z d Z d Z d Z RS( s The FileTouch object; touches the file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileTouchc O s t t | j | | | d S( s:
Arguments:
None
Returns:
Nothing
N( R
R$ R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR y s c C s t t | j | j d k r t j j | j } t j | t j sn t
d d | g } | j n t j | j t j s | j q n | S( s0 Make certain the file exists and return ourself.t mkdirs -pN(
R
R$ R R R R R t dirnamet accesst F_OKR t runt _createFile( R t dirPatht cmd( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
c C s# t d | j g } | j d S( s Creates the targe file.t touchN( R R R) ( R R, ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR* s ( R R R R R R! R R R* ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR$ h s
t FileOpenc B s e Z d Z e j d Z e d Z d Z d d Z d d Z
d d Z e
j d Z d d Z d
Z d Z d Z d
Z d Z d d Z d Z e d Z RS( s The FileOpen object; provides basic access to a file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileOpenc C s | j S( N( t _FileOpen__file( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt file s c C s | j j d S( N( R0 t flush( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR1 s ic C s | j j | S( N( R0 t read( R t
numberOfBytes( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR2 s c C s | j j | S( N( R0 t readline( R R3 ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR4 s c C s- | d k r | j j S| j j | Sd S( N( R R0 t readlines( R t numberOfBytesHint( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR5 s
c C s | j j | | d S( N( R0 t seek( R t offsett whence( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR7 s c C s0 | d k r | j j n | j j | d S( N( R R0 t truncate( R t size( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR: s c C s | j j | d S( N( R0 t write( R t string( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR< s c C s | j j | d S( N( R0 t writeline( R t sequenceOfStrings( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt
writelines s c C s
| j j S( N( R0 t next( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRA s c C s_ t t | j | j d k r@ t j | j | j | _ n t j | j | j
| _ | S( s! Open the file and return ourself.N( R
R. R R R R t openR t _osModet fdopent _FileOpen__modeR/ ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
c C s) | j j t t | j | | | S( s Close the file.( R0 t closeR
R. R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
t rc O s t t | j | | | d } t | d k rP d | d k rP t j } nH | d d k rl t j } n, | d d k r t j t j B} n t j } | d d k r | t j
B} n d | _ | | _ | | _
d S( s:
Arguments:
None
Returns:
Nothing
i t +i RG t wt aN( R
R. R R t lenR t O_RDWRt O_RDONLYt O_WRONLYt O_TRUNCt O_APPENDR/ RE t _FileOpen__osMode( R R t modeR R t osMode( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s " c C s | S( N( ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __iter__ s c C s | j S( N( RQ ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRC s N( R R R R R R! R" R0 R1 R2 R4 R R5 R t SEEK_SETR7 R: R< R@ RA R R R RT RC ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR. s" t FileLockc B s; e Z d Z e j d Z d d Z d Z d Z RS( s The FileLock object; a context manager providing interlocked access on
a file.
The file is created, if necessary.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
_timeout - timeout in seconds (None = no timeout)
s utils.FileLockc O s& t t | j | | | | _ d S( s
Arguments:
filePath - (str) path to file
mode - (str) open mode
timeout - (int) timeout in seconds; may be None
Returns:
Nothing
N( R
RV R t _timeout( R R RR t timeoutR R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR : s c C s t t | j | j t j k r7 t j } d } n t j } d } | j d k r | j j d j
d | j d | j d | t | j t d j
d | j d | j t j | j | Wd QXn8 | j j d j
d | j d | t j | j | | S(
s_ If the open mode is read-only the file is locked shared else it is
locked exclusively.
t sharedt exclusives' attempting to lock {f} in {s}s mode {m}t ft st ms! Could not lock {f} in {s} secondsNs attempting to lock {f} mode {m}( R
RV R RC R RM t fcntlt LOCK_SHt LOCK_EXRW R R! t debugt formatR R t _t flockR0 ( R t flockModet lockModeString( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR G s(
c C s` t j | j t j | t k rD | j j d j d | j n t t
| j | | | S( s Unlocks and closes the file.s released lock {f}R[ ( R^ Rd R0 t LOCK_UNR R! Ra Rb R R
RV R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR d s "N(
R R R R R R! R R R R ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRV & s
t FileTempc B s8 e Z d Z e j d Z d d d d Z d Z RS( s The FileTemp object; a context manager providing temporary files
with specified (or default) owner and permissions.
An optional destination parameter specifies the location to which the
temp file should be moved at exit, if no exception is encountered.
The move, if specified, is performed after performing the owner
manipulations.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileTempc O s| t j } t t | j | d d d | d | sN t t j } n | s] d } n | | _ | | _ | | _
d S( s
Arguments:
owner - (str) the owner to set for the file
ownerPerm - (str) the permissions to set for the owner
destination (str) the path to which to move the temp file on exit
Returns:
Nothing
i s r+R i t rwN( t tempfilet mkstempR
Rh R t strR t geteuidt _FileTemp__ownert _FileTemp__ownerPermt _FileTemp__destination( R t ownert ownerPermt destinationR R t tmpFile( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
' c C s6 | } | d k r | j d k r y t d | j | j g } | j t d d j d | j g | j g } | j | j j t d | j | j g } | j Wq t
k
r } | } q Xn | d k s | j d k ry# t d | j g } | j WqqXn t t | j
| | | S( Nt chownt chmodt =t ut mvt rm( R Rp R Rn R R) t joinRo R0 RF t ExceptionR
Rh R ( R R R R t exceptionR, t ex( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s*
*
N( R R R R R R! R R R ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRh w s ( R t
__future__R t errnoR^ t gettextt grpR R t statRj t timeR R R t installt objectR R$ R. RV Rh ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt s$
;=Q Logger.pyo 0000644 00000007252 14722167475 0006541 0 ustar 00
.t_c @ s` d Z d d l Z d d l Z d d l Z d d l Z d d l m Z d e f d YZ d S( si
Logger - VDO manager logging
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Logger.py#3 $
iN( t
MethodTypet Loggerc B s~ e Z d Z e j j e j d Z e Z
d Z e
d Z e
d e d Z e
d Z e
d Z d Z RS( s Wrappers and configuration methods for the Python logger.
Attributes:
logfile (string): the path to the logfile if specified.
myname (string): name of the command being run.
quiet (bool): if True, don't print to stdout.
i c C s" | j s | GHn | j | d S( s4 Print a status message to stdout and log it as well.N( t quiett info( t clst loggert msg( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt announce/ s c C s; | | _ | | _ | } d } | r* d n d | } t j } | j t j t j t j } | j t j
| j | | j | r t j n t j | j
| | j d k ry t j j | j rt j j | j rt | j d } t j d | } n! t j j | j d d d d
} t j
d | }
| j |
| j | ret j n t j | j
| Wqt k
r} | j d j d
| j d | qXn yS t j j d d } | j t j
| j | | j t j | j
| Wn) t k
r6} | j d j | n Xd S( s8 Configure the logging system according to the arguments.s : %(levelname)s - %(message)ss
: %(name)st t wt streamt maxBytesi
i t backupCounti s %(asctime)s %(name)ss. Unable to configure logging to {logfile}: {ex}t logfilet ext addresss /dev/logs, Unable to configure logging for rsyslog: {0}Ni ( i ( t mynameR
t loggingt getLoggert setLevelt NOTSETt
StreamHandlert syst stderrt setFormattert Formattert DEBUGt WARNINGt
addHandlert Nonet ost patht existst isfilet opent handlerst RotatingFileHandlert INFOt Exceptiont warnt formatt
SysLogHandler( R t nameR
t debugt debuggingt
formatBaset debugBaseR t handlert logstreamt formatterR ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt configure7 sB
+
c C s. t j | } t | j | | j | _ | S( s; Returns a Python logger decorated with the announce method.( R R R R t __class__( R R* R ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR b s c C s6 g } | j d k r2 | j d t | j n | S( sB Return a list of strings containing the logging options specified.s
--logfile=N( R
R t appendt str( R t options( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt loggingOptionsj s c C s t t | j d S( N( t superR t __init__( t self( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR9 u s N( t __name__t
__module__t __doc__R R t basenameR t argvR t FalseR R R
t classmethodR R2 R R7 R9 ( ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR s * ( R= R t logging.handlersR R t typesR t objectR ( ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt s FileUtils.pyc 0000644 00000027746 14722167475 0007220 0 ustar 00
.t_c @ s' d Z d d l m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l
Z
d d l Z d d l m Z d d l
m
Z
m Z e j d d e f d YZ d
e f d YZ d e f d
YZ d e f d YZ d e f d YZ d S( s
FileUtils - Provides dmmgmnt file-related capabilities.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/FileUtils.py#1 $
i( t print_functionNi ( t Command( t Timeoutt TimeoutErrort utilst FileBasec B sh e Z d Z e j d Z e d Z d Z d Z d Z
e d Z e j d Z RS( s The FileBase object; provides basic file control.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileBasec C s | j S( N( t _FileBase__filePath( t self( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt path: s c O sA t t | j t j j | | _ | j d d | _ d S( s:
Arguments:
None
Returns:
Nothing
t fdN(
t superR t __init__t osR t realpathR t gett Nonet
_FileBase__fd( R t filePatht argst kwargs( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR A s c C s | S( N( ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __enter__M s c C s t S( N( t False( R t
exceptionTypet exceptionValuet traceback( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __exit__Q s c C s | j S( N( R ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt _fdX s c C s
| | _ d S( N( R ( R t value( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR _ s (
t __name__t
__module__t __doc__t loggingt getLoggert logt propertyR R R R R t setter( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR - s t FileTouchc B s8 e Z d Z e j d Z d Z d Z d Z RS( s The FileTouch object; touches the file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileTouchc O s t t | j | | | d S( s:
Arguments:
None
Returns:
Nothing
N( R
R$ R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR y s c C s t t | j | j d k r t j j | j } t j | t j sn t
d d | g } | j n t j | j t j s | j q n | S( s0 Make certain the file exists and return ourself.t mkdirs -pN(
R
R$ R R R R R t dirnamet accesst F_OKR t runt _createFile( R t dirPatht cmd( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
c C s# t d | j g } | j d S( s Creates the targe file.t touchN( R R R) ( R R, ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR* s ( R R R R R R! R R R* ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR$ h s
t FileOpenc B s e Z d Z e j d Z e d Z d Z d d Z d d Z
d d Z e
j d Z d d Z d
Z d Z d Z d
Z d Z d d Z d Z e d Z RS( s The FileOpen object; provides basic access to a file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileOpenc C s | j S( N( t _FileOpen__file( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt file s c C s | j j d S( N( R0 t flush( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR1 s ic C s | j j | S( N( R0 t read( R t
numberOfBytes( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR2 s c C s | j j | S( N( R0 t readline( R R3 ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR4 s c C s- | d k r | j j S| j j | Sd S( N( R R0 t readlines( R t numberOfBytesHint( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR5 s
c C s | j j | | d S( N( R0 t seek( R t offsett whence( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR7 s c C s0 | d k r | j j n | j j | d S( N( R R0 t truncate( R t size( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR: s c C s | j j | d S( N( R0 t write( R t string( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR< s c C s | j j | d S( N( R0 t writeline( R t sequenceOfStrings( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt
writelines s c C s
| j j S( N( R0 t next( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRA s c C s_ t t | j | j d k r@ t j | j | j | _ n t j | j | j
| _ | S( s! Open the file and return ourself.N( R
R. R R R R t openR t _osModet fdopent _FileOpen__modeR/ ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
c C s) | j j t t | j | | | S( s Close the file.( R0 t closeR
R. R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
t rc O s t t | j | | | d } t | d k rP d | d k rP t j } nH | d d k rl t j } n, | d d k r t j t j B} n t j } | d d k r | t j
B} n d | _ | | _ | | _
d S( s:
Arguments:
None
Returns:
Nothing
i t +i RG t wt aN( R
R. R R t lenR t O_RDWRt O_RDONLYt O_WRONLYt O_TRUNCt O_APPENDR/ RE t _FileOpen__osMode( R R t modeR R t osMode( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s " c C s | S( N( ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt __iter__ s c C s | j S( N( RQ ( R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRC s N( R R R R R R! R" R0 R1 R2 R4 R R5 R t SEEK_SETR7 R: R< R@ RA R R R RT RC ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR. s" t FileLockc B s; e Z d Z e j d Z d d Z d Z d Z RS( s The FileLock object; a context manager providing interlocked access on
a file.
The file is created, if necessary.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
_timeout - timeout in seconds (None = no timeout)
s utils.FileLockc O s& t t | j | | | | _ d S( s
Arguments:
filePath - (str) path to file
mode - (str) open mode
timeout - (int) timeout in seconds; may be None
Returns:
Nothing
N( R
RV R t _timeout( R R RR t timeoutR R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR : s c C s t t | j | j t j k r7 t j } d } n t j } d } | j d k r | j j d j
d | j d | j d | t | j t d j
d | j d | j t j | j | Wd QXn8 | j j d j
d | j d | t j | j | | S(
s_ If the open mode is read-only the file is locked shared else it is
locked exclusively.
t sharedt exclusives' attempting to lock {f} in {s}s mode {m}t ft st ms! Could not lock {f} in {s} secondsNs attempting to lock {f} mode {m}( R
RV R RC R RM t fcntlt LOCK_SHt LOCK_EXRW R R! t debugt formatR R t _t flockR0 ( R t flockModet lockModeString( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR G s(
c C s` t j | j t j | t k rD | j j d j d | j n t t
| j | | | S( s Unlocks and closes the file.s released lock {f}R[ ( R^ Rd R0 t LOCK_UNR R! Ra Rb R R
RV R ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR d s "N(
R R R R R R! R R R R ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRV & s
t FileTempc B s8 e Z d Z e j d Z d d d d Z d Z RS( s The FileTemp object; a context manager providing temporary files
with specified (or default) owner and permissions.
An optional destination parameter specifies the location to which the
temp file should be moved at exit, if no exception is encountered.
The move, if specified, is performed after performing the owner
manipulations.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
s utils.FileTempc O s| t j } t t | j | d d d | d | sN t t j } n | s] d } n | | _ | | _ | | _
d S( s
Arguments:
owner - (str) the owner to set for the file
ownerPerm - (str) the permissions to set for the owner
destination (str) the path to which to move the temp file on exit
Returns:
Nothing
i s r+R i t rwN( t tempfilet mkstempR
Rh R t strR t geteuidt _FileTemp__ownert _FileTemp__ownerPermt _FileTemp__destination( R t ownert ownerPermt destinationR R t tmpFile( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s
' c C s6 | } | d k r | j d k r y t d | j | j g } | j t d d j d | j g | j g } | j | j j t d | j | j g } | j Wq t
k
r } | } q Xn | d k s | j d k ry# t d | j g } | j WqqXn t t | j
| | | S( Nt chownt chmodt =t ut mvt rm( R Rp R Rn R R) t joinRo R0 RF t ExceptionR
Rh R ( R R R R t exceptionR, t ex( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyR s*
*
N( R R R R R R! R R R ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyRh w s ( R t
__future__R t errnoR^ t gettextt grpR R t statRj t timeR R R t installt objectR R$ R. RV Rh ( ( ( s7 /usr/lib/python2.7/site-packages/vdo/utils/FileUtils.pyt s$
;=Q Transaction.pyo 0000644 00000013715 14722167475 0007610 0 ustar 00
.t_c @ sj d Z d d l m Z d d l Z d d l Z d d l Z e j d d e f d YZ d Z d S( s~
Transaction - provides transactional support
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Transaction.py#1 $
i( t wrapsNt Transactionc B sY e Z d Z i Z e d Z d Z d d Z d Z e d Z
d Z RS( s% Client-visible transaction object.
c C s | j d S( s< Returns the current transaction for the current thread.
i( t _threadTransactionList( t cls( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt transaction- s c C s | j j | d S( s Adds callable undoStage to transaction stages.
Arguments:
undoStage (callable) - callable to execute as part of
transaction roll-back
N( t _Transaction__undoStagest append( t selft undoStage( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt addUndoStage4 s c C s
t d S( s+ Sets the message to handle if there is an exception.
If message is specified and an exception occurs the exception
will be appended to the message using "; {0}" where "{0}" represents
the exception.
If message is not specified, the exception will be coerced to
a string and passed to handleMessage.
Specifying handleMessage as None will clear both handleMessage and
message.
Arguments:
handleMessage (callable) - method to handle message
message (string) - message
N( t NotImplementedError( R t
handleMessaget message( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt
setMessage> s c C s t t | j g | _ d S( N( t superR t __init__R ( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR T s c C sQ d } t j j } y | j | } Wn$ t k
rL g } | | j | d t f f d Y t f d } | S( sG Method decorator providing transactional capabilities to the method.
t _Transactionc sP e Z d Z e d Z e d Z d Z f d Z d d Z RS( sY Decorator-local transaction object providing actual transaction
capabilities.
c S s | j j | | j S( s` Adds, and returns, a transaction to the transaction list for the
current thread.
( R R R ( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt addTransaction s c S s | j j d S( sB Removes the current transaction for for the current thread.
N( R t pop( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt removeTransaction s c S s | j d k r_ | j d k rI | j t d j | j t | q_ | j t | n | j } | j x- | D]% } y | Wq} t k
r q} Xq} Wd S( s Performs the undo processing of the transaction.
Exceptions from the undo stages are ignored.
Arguments:
exception - the exception which resulted in undo being called
s {0}; {1}N( t _Transaction__handleMessageR t _Transaction__messaget _t formatt strR t reverset Exception( R t exceptiont
undoStagesR ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt undo s
c s) t | j d | _ d | _ d S( N( R R R R! R" ( R ( R ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR s c S s1 | | _ | j d k r$ d | _ n | | _ d S( N( R! R R" ( R R R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR
s N(
R R R R R R R* R R R
( ( R ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR s c sz j } d } zV y | | } Wn< t k
rf } | j | t | | t j d n XWd j X| S( sD Wrapper method providing transactional processing capabilities.
i N( R R R' R* t typet syst exc_infoR ( t argst kwargsR t resultt ex( R t func( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt wrap s
$ ( R R ( R2 R3 ( ( R R2 s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt
transactionalz s J (
R t functoolsR t gettextR, R t installt objectR R4 ( ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt s
X __init__.pyc 0000644 00000074651 14722167475 0007054 0 ustar 00
;Xc @ sb d Z d d l m Z d d l m Z m Z m Z d d l m Z m
Z
d d l Z d d l m
Z d d l m Z d d l Z d d l Z d d l Z e j e Z d d l Z d d l Z d d l Z d d l Z d d l Z e r y d d l Z Wq(e k
rd Z d Z q(Xn d d l Z d d l Z e rId d l! Z! n d d l" Z" d d l# m$ Z$ d d
l% m& Z& m' Z' m( Z( m) Z) m* Z* m+ Z+ m, Z, m- Z- m. Z. m/ Z/ m0 Z0 m1 Z1 m2 Z2 d d l3 m4 Z4 m5 Z5 m6 Z6 m7 Z7 m8 Z8 d d l9 m: Z: d d
l m; Z; m< Z< m= Z= m> Z> m? Z? m@ Z@ mA ZA mB ZB mC ZC mD ZD mE ZE mF ZF mG ZG mH ZH mI ZI d d d d d d d d d d d d d d d d d d d d! d" d# d$ d% d& g ZJ eK e j eA re jL n e jM d' d( ZN d) d* d+ d, d- d. d/ g ZO d0 d1 g ZP d d2 l9 mQ ZQ d3 ZR eB d3 ZS eB d4 ZT eK e jU jV d5 pEd6 ZW d7 eX f d8 YZY eA re jZ j[ Z\ e] e\ e jZ j^ g Z_ d9 Z` n d: Z` d d ea d d ea d; Zb d< Zc d= Zd ed Ze y d d> lf mg Zd Wn e k
rn Xd? d@ Zh dA dB Zi e d k r.dA dC Zi n dD Zj eA rRdE Zk dF Zl n( d dG l mm Zm mn Zn dH Zk dI Zl e; ek dJ e; el dK dL Zo dM Zp dN Zq eB dN Zr d dO Zs dP Zt et ju dQ Zv dR Zw dS Zx d Zy eB dT Zz dV Z{ dW dA d dX Z| dW dA dY Z} eA r?dW dA dZ Z~ n dW dA d[ Z~ e; e~ d\ e4 d] d^ d_ d` dQ da Z e] db j Z e] dc j Z e] d3 dd g Z d de df Z y d dg l m Z Wn& e k
rd Z ea Z dh Z n4 Xe Z dN Z eB di Z eA r(dj Z n dk Z e; e dl dm Z e j dn k rid do l m Z n d dp l m Z e Z dq Z y e j dr e Z Wn e k
rea Z n Xd ds Z e re j Z n e j e Z dt Z du Z dv Z e4 d] d` d_ dw dx dy dz e d{ Z d Z d Z d Z d Z d Z d Z d S( s4 passlib.utils -- helpers for writing password hashesi( t JYTHON( t
b2a_base64t
a2b_base64t Error( t b64encodet b64decodeN( t lookup( t update_wrappers not present under Jython( t warn(
t BASE64_CHARSt
AB64_CHARSt HASH64_CHARSt BCRYPT_CHARSt Base64Enginet LazyBase64Enginet h64t h64bigt bcrypt64t ab64_encodet ab64_decodet b64s_encodet b64s_decode( t deprecated_functiont deprecated_methodt memoized_propertyt
classpropertyt
hybrid_method( t ExpectedStringError( t add_doct
join_bytest join_byte_valuest join_byte_elemst iranget imapt PY3t ut join_unicodet unicodet byte_elem_valuet
nextgettert unicode_or_bytes_typest get_method_functiont suppress_causeR t sys_bitst unix_crypt_schemest rounds_cost_valuest consteqt saslprept xor_bytest render_bytest
is_same_codect
is_ascii_safet to_bytest
to_unicodet
to_native_strt has_cryptt
test_cryptt
safe_cryptt tickt rngt getrandbytest
getrandstrt generate_passwordt is_crypt_handlert is_crypt_contextt has_rounds_infot
has_salt_infoi g ?t sha512_cryptt sha256_cryptt
sha1_cryptt bcryptt md5_cryptt
bsdi_cryptt des_cryptt lineart log2( t MissingBackendErrort t t PASSLIB_MAX_PASSWORD_SIZEi t
SequenceMixinc B sM e Z d Z d Z d Z d Z d Z d Z d Z d Z RS( s
helper which lets result object act like a fixed-length sequence.
subclass just needs to provide :meth:`_as_tuple()`.
c C s t d d S( Ns implement in subclass( t NotImplemented( t self( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt _as_tuple s c C s t | j S( N( t reprRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __repr__ s c C s | j | S( N( RS ( RR t idx( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __getitem__ s c C s t | j S( N( t iterRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __iter__ s c C s t | j S( N( t lenRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __len__ s c C s | j | k S( N( RS ( RR t other( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __eq__ s c C s | j | S( N( R] ( RR R\ ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __ne__ s (
t __name__t
__module__t __doc__RS RU RW RY R[ R] R^ ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRP s c C se t j t | j } | s" t S| j | } | rJ | j t k rJ t S| t | d j t
k S( s* test if function accepts specified keywordi( t inspectt signatureR) t
parameterst Falset gett kindt _VAR_ANY_SETt Truet listt _VAR_KEYWORD( t funct keyt paramst arg( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt accepts_keyword s c C s1 t j t | } | | j k p0 | j d k S( s* test if function accepts specified keywordN( Rb t
getargspecR) t argst keywordst None( Rl Rm t spec( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRp s c s t | t r | g } n t | j } | r t | t rK | g } n xE | D]: | rp | k rp qR n | k rR | j qR qR Wn | rx| D] t f d | D r q n | r&x t | D]8 \ } } t | r Pn | r t | | r Pq q Wt | } nu | rxl t t | D]I \ }
} t | | r?t | |
} | | d | k st
Pq?q?Wd } n d } | j | q Wn | st | | _ n d S( s
helper to update mixin classes installed in target class.
:param target:
target class whose bases will be modified.
:param add:
class / classes to install into target's base class list.
:param remove:
class / classes to remove from target's base class list.
:param append:
by default, prepends mixins to front of list.
if True, appends to end of list instead.
:param after:
optionally make sure all mixins are inserted after
this class / classes.
:param before:
optionally make sure all mixins are inserted before
this class / classes.
:param dryrun:
optionally perform all calculations / raise errors,
but don't actually modify the class.
c 3 s | ] } t | Vq d S( N( t
issubclass( t .0t base( t mixin( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s i i N(
t
isinstancet typeRj t __bases__t removet anyt enumerateRv RZ t reversedt AssertionErrort insertt tuple( t targett addR} t appendt beforet aftert dryrunt basesRV Rx t end_idx( ( Ry s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt update_mixin_classes sB
c c s | d k r t d n t | t j rq t | } d } x | | k rm | | } | | | !V| } qB Wn t | t j r t | } xd t r t j | | } y t
| } Wn t k
r Pn Xt j | f | Vq Wn t
d d S( s8
split iterable into chunks of elements.
i s size must be positive integeri s source must be iterableN( t
ValueErrorRz t collectionst SequenceRZ t IterableRX Ri t itertoolst islicet nextt
StopIterationt chaint TypeError( t sourcet sizet endt it nt itrt chunk_itrt first( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt batch s&
c C s5 t | t r6 t | t s- t d n t } nB t | t rl t | t sc t d n t } n t d t | t | k } | r | } d } n | s | } d } n | r xh t | | D] \ } } | | | AO} q Wn: x7 t | | D]& \ } } | t | t | AO} qW| d k S( s Check two strings/bytes for equality.
This function uses an approach designed to prevent
timing analysis, making it appropriate for cryptography.
a and b must both be of the same type: either str (ASCII only),
or any type that supports the buffer protocol (e.g. bytes).
Note: If a and b are of different lengths, or if an error occurs,
a timing attack could theoretically reveal information about the
types and lengths of a and b--but not their values.
s) inputs must be both unicode or both bytesi i ( Rz R% R Re t bytesR" RZ t zipt ord( t leftt rightt is_py3_bytest same_sizet tmpt resultt lt r( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR. / s, ( t compare_digestt ,c C sX | j } | j | r( | d } n | s2 g Sg | j | D] } | j ^ qB S( sR split comma-separated string into list of elements,
stripping whitespace.
i( t stript endswitht split( R t sept elem( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
splitcommaz s
t valuec s t | t s+ t d t | f n t j t j t f d | D } t j d | } | sx t
St j } | | d r | | d s t d | n t j
} n | } t j } t j } t j } t j } t j } t j }
t j } t j } t j }
xv| D]n} | s=t d | sVt d | | rut d | n | | rt d
| n | | rt d | n | | rt d | n | | rt d
| n |
| rt d | n | | r/t d | n | | rNt d | n |
| rmt d | n | | r t d | q q W| S( s Normalizes unicode strings using SASLPrep stringprep profile.
The SASLPrep profile is defined in :rfc:`4013`.
It provides a uniform scheme for normalizing unicode usernames
and passwords before performing byte-value sensitive operations
such as hashing. Among other things, it normalizes diacritic
representations, removes non-printing characters, and forbids
invalid characters such as ``\n``. Properly internationalized
applications should run user passwords through this function
before hashing.
:arg source:
unicode string to normalize & validate
:param param:
Optional noun identifying source parameter in error messages
(Defaults to the string ``"value"``). This is mainly useful to make the caller's error
messages make more sense contextually.
:raises ValueError:
if any characters forbidden by the SASLPrep profile are encountered.
:raises TypeError:
if input is not :class:`!unicode`
:returns:
normalized unicode string
.. note::
This function is not available under Jython,
as the Jython stdlib is missing the :mod:`!stringprep` module
(`Jython issue 1758320 `_).
.. versionadded:: 1.6
s$ input must be unicode string, not %sc 3 s3 | ]) } | s | r' t n | Vq d S( N( t _USPACE( Rw t c( t in_table_b1t in_table_c12( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s t NFKCi is malformed bidi sequence in s$ failed to strip B.1 in mapping stages( failed to replace C.1.2 in mapping stages$ unassigned code points forbidden in s control characters forbidden in s$ private use characters forbidden in s" non-char code points forbidden in s surrogate codes forbidden in s! non-plaintext chars forbidden in s! non-canonical chars forbidden in s1 display-modifying / deprecated chars forbidden ins tagged characters forbidden in s forbidden bidi character in ( Rz R% R R{ t
stringprepR R R$ t unicodedatat normalizet _UEMPTYt in_table_d1R t in_table_d2t in_table_a1t in_table_c21_c22t in_table_c3t in_table_c4t in_table_c5t in_table_c6t in_table_c7t in_table_c8t in_table_c9R ( R t paramt datat is_ral_chart is_forbidden_bidi_charR R R R R R R R R R ( ( R R s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR/ sf ,
c C s t d t d S( s stub for saslprep()s> saslprep() support requires the 'stringprep' module, which is N( t NotImplementedErrort _stringprep_missing_reason( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR/ s c G sH t | t r! | j d } n | t d | D } | j d S( s& Peform ``%`` formating using bytes in a uniform manner across Python 2/3.
This function is motivated by the fact that
:class:`bytes` instances do not support ``%`` or ``{}`` formatting under Python 3.
This function is an attempt to provide a replacement:
it converts everything to unicode (decoding bytes instances as ``latin-1``),
performs the required formatting, then encodes the result to ``latin-1``.
Calling ``render_bytes(source, *args)`` should function roughly the same as
``source % args`` under Python 2.
s latin-1c s s3 | ]) } t | t r' | j d n | Vq d S( s latin-1N( Rz R t decode( Rw Ro ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( Rz R R R t encode( R Rr R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR1 s
c C s t j | d S( Nt big( t intt
from_bytes( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt bytes_to_int" s c C s | j | d S( NR ( R4 ( R t count( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt int_to_bytes$ s ( t hexlifyt unhexlifyc C s t t | d S( Ni ( R R ( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR ) s c C s t d | d >| S( Ns %%0%dxi ( R ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR + s s/ decode byte string as single big-endian integers/ encode integer as single big-endian byte stringc C s# t t | t | At | S( s; Perform bitwise-xor of two byte strings (must be same size)( R R RZ ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR0 1 s c C sB t | } | | k r6 | | d | } | | | S| | Sd S( s; repeat or truncate string, so it has length i N( RZ ( R R t curt mult( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
repeat_string5 s
t c C s^ t | } | | k rR | d k rB t | t r9 t n t } n | | | | S| | Sd S( s> right-pad or truncate string, so it has length N( RZ Rt Rz R% t _UNULLt _BNULL( R R t padR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt right_pad_stringA s t
aA:#!t asciic C s t j | t k S( sR Test if codec is compatible with 7-bit ascii (e.g. latin-1, utf-8; but not utf-16)( t _ASCII_TEST_UNICODER t _ASCII_TEST_BYTES( t codec( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt is_ascii_codecQ s c C s< | | k r t S| o | s t St | j t | j k S( s3 Check if two codec names are aliases for same codec( Ri Re t
_lookup_codect name( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR2 U s
s i c s5 t | t r t n t t f d | D S( s< Check if string (bytes or unicode) contains only 7-bit asciic 3 s | ] } | k Vq d S( N( ( Rw R ( R ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys b s ( Rz R t _B80t _U80t all( R ( ( R s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR3 _ s s utf-8c C s} | s t t | t rN | rG t | | rG | j | j | S| Sn+ t | t rj | j | St | | d S( s Helper to normalize input to bytes.
:arg source:
Source bytes/unicode to process.
:arg encoding:
Target encoding (defaults to ``"utf-8"``).
:param param:
Optional name of variable/noun to reference when raising errors
:param source_encoding:
If this is specified, and the source is bytes,
the source will be transcoded from *source_encoding* to *encoding*
(via unicode).
:raises TypeError: if source is not unicode or bytes.
:returns:
* unicode strings will be encoded using *encoding*, and returned.
* if *source_encoding* is not specified, byte strings will be
returned unchanged.
* if *source_encoding* is specified, byte strings will be transcoded
to *encoding*.
N( R Rz R R2 R R R% R ( R t encodingR t source_encoding( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR4 d s
c C sN | s t t | t r | St | t r; | j | St | | d S( s Helper to normalize input to unicode.
:arg source:
source bytes/unicode to process.
:arg encoding:
encoding to use when decoding bytes instances.
:param param:
optional name of variable/noun to reference when raising errors.
:raises TypeError: if source is not unicode or bytes.
:returns:
* returns unicode strings unchanged.
* returns bytes strings decoded using *encoding*
N( R Rz R% R R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR5 s
c C sB t | t r | j | St | t r/ | St | | d S( N( Rz R R R% R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR6 s
c C sB t | t r | St | t r/ | j | St | | d S( N( Rz R R% R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR6 s
s> Take in unicode or bytes, return native string.
Python 2: encodes unicode using specified encoding, leaves bytes alone.
Python 3: leaves unicode alone, decodes bytes using specified encoding.
:raises TypeError: if source is not unicode or bytes.
:arg source:
source unicode or bytes string.
:arg encoding:
encoding to use when encoding unicode or decoding bytes.
this defaults to ``"utf-8"``.
:param param:
optional name of variable/noun to reference when raising errors.
:returns: :class:`str` instance
t
deprecateds 1.6t removeds 1.7c C s t | | d d S( s' deprecated, use to_native_str() insteadR t hash( R6 ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt to_hash_str s s true t yes y on 1 enable enableds# false f no n off 0 disable disabledt nonet booleanc C s | t t d g k s t t | t r | j j } | t k rL t S| t k r\ t S| t
k rl | St d | | f n- t | t r | S| d k r | St | Sd S( s\
helper to convert value to boolean.
recognizes strings such as "true", "false"
s unrecognized %s value: %rN(
Ri Re Rt R Rz R( t lowerR t _true_sett
_false_sett _none_setR t bool( R R R t clean( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt as_bool s ( t cryptc C s d S( N( Rt ( t secretR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s s *:!c C s t | t ra | } y | j d } Wn t k
r< d SX| j d | k sa t d n t | k r| t d n t | t r | j d } n t | | } | s | d t
k r d S| S( Ns utf-8s" utf-8 spec says this can't happen!s null character in secretR i ( Rz R R t UnicodeDecodeErrorRt R R t _NULLR t _cryptt _invalid_prefixes( R R t origR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s
c C s t | t r! | j d } n t | k r< t d n t | t r] | j d } n t | | } | sv d S| j d } | d t k r d S| S( Ns utf-8s null character in secretR i ( Rz R% R R R R Rt R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s s Wrapper around stdlib's crypt.
This is a wrapper around stdlib's :func:`!crypt.crypt`, which attempts
to provide uniform behavior across Python 2 and 3.
:arg secret:
password, as bytes or unicode (unicode will be encoded as ``utf-8``).
:arg hash:
hash or config string, as ascii bytes or unicode.
:returns:
resulting hash as ascii unicode; or ``None`` if the password
couldn't be hashed due to one of the issues:
* :func:`crypt()` not available on platform.
* Under Python 3, if *secret* is specified as bytes,
it must be use ``utf-8`` or it can't be passed
to :func:`crypt()`.
* Some OSes will return ``None`` if they don't recognize
the algorithm being used (though most will simply fall
back to des-crypt).
* Some OSes will return an error string if the input config
is recognized but malformed; current code converts these to ``None``
as well.
c C s% | r | s t t | | | k S( s check if :func:`crypt.crypt` supports specific hash
:arg secret: password to test
:arg hash: known hash of password to use as reference
:returns: True or False
( R R9 ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR8 A s t win32( t clock( t timec C sB t j d | } | r> t d | j d j d D Sd S( s helper to parse version strings (\d+(?:\.\d+)+)c s s | ] } t | Vq d S( N( R ( Rw R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys Y s i t .N( t ret searchR t groupR Rt ( R t m( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
parse_versionU s &i c C s d d l m } t | d rd t | d rd y | j } Wqd t k
r` | j d } qd Xn t d | t t d r t j n d t
t t j t j
t r t j d j d
n d f } t | | j d j d
S( s. generate prng seed value from system resourcesi( t sha512t getstatet getrandbitsi i s %s %s %s %.15f %.15f %st getpidi s latin-1i s utf-8i i N( t hashlibR
t hasattrR R R R# t osR
Rt t idt objectR R t has_urandomt urandomR R R t hexdigest( R R
t text( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt genseedq s
(c s) s
t S f d } t | S( s] return byte-string containing *count* number of randomly generated bytes, using specified rngc 3 sM j d > } d } x- | k rH | d @V| d L} | d 7} q Wd S( Ni i i i ( R ( R R ( R R; ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt helper s
( t _BEMPTYR ( R; R R ( ( R R; s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR< s c s d k r t d n t d k rB t d n d k rV S f d } t t r t | St | Sd S( s| return string containing *count* number of chars/bytes, whose elements are drawn from specified charset, using specified rngi s count must be >= 0s alphabet must not be emptyi c 3 sT j d } d } x1 | k rO | V| } | d 7} q Wd S( Ni i ( t randrange( R R ( t charsetR t lettersR; ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR s
N( R RZ Rz R% R$ R ( R; R R R ( ( R R R R; s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR= s
t4 2346789ABCDEFGHJKMNPQRTUVWXYZabcdefghjkmnpqrstuvwxyzs 2.0t replacements/ passlib.pwd.genword() / passlib.pwd.genphrase()i
c C s t t | | S( sw generate random password using given length & charset
:param size:
size of password.
:param charset:
optional string specified set of characters to draw from.
the default charset contains all normal alphanumeric characters,
except for the characters ``1IiLl0OoS5``, which were omitted
due to their visual similarity.
:returns: :class:`!str` containing randomly generated password.
.. note::
Using the default character set, on a OS with :class:`!SystemRandom` support,
this function should generate passwords with 5.7 bits of entropy per character.
( R= R; ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR> s R t setting_kwdst context_kwdst verifyR t identifyc s t f d t D S( s4 check if object follows the :ref:`password-hash-api`c 3 s | ] } t | Vq d S( N( R ( Rw R ( t obj( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( R t _handler_attrs( R# ( ( R# s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR? s t needs_updatet genconfigt genhasht encryptc s t f d t D S( sO check if object appears to be a :class:`~passlib.context.CryptContext` instancec 3 s | ] } t | Vq d S( N( R ( Rw R ( R# ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( R t _context_attrs( R# ( ( R# s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR@ s c C s% d | j k o$ t | d d d k S( s_ check if handler provides the optional :ref:`rounds information ` attributest roundst
min_roundsN( R t getattrRt ( t handler( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRA s c C s% d | j k o$ t | d d d k S( s[ check if handler provides the optional :ref:`salt information ` attributest saltt
min_salt_sizeN( R R, Rt ( R- ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRB s t ( s names setting_kwdsR R! s hashR" ( R% R& R' R! R( R" ( Ra t passlib.utils.compatR t binasciiR R R t _BinAsciiErrort base64R R R t codecsR R t functoolsR R Rb t loggingt getLoggerR_ t logt mathR t syst randomR R t ImportErrorRt R R R t typest warningsR t passlib.utils.binaryR R
R R R
R R R R R R R R t passlib.utils.decorR R R R R t passlib.excR R R R R R R! R" R# R$ R% R& R' R( R) R* t __all__R t maxsizet maxintR+ R, R- RL R R R t environRf t MAX_PASSWORD_SIZER RP t Parametert VAR_KEYWORDRk t sett VAR_POSITIONALRh Rp Re R R R. t str_consteqt hmacR R R/ R1 R R R R R0 R R R R R R R R R2 R R R3 R4 R5 R6 R R R R R R R R R7 R9 Ri R R R8 t platformR t timerR: R R R R R t SystemRandomR; t RandomR< R= t
_52charsetR> R$ R? R) R@ RA RB ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt sJ
X(d .
V >
%
!
Timeout.pyo 0000644 00000005215 14722167475 0006745 0 ustar 00
.t_c @ sB d Z d d l Z d e f d YZ d e f d YZ d S( s
Timeout - context manager that implements a timeout.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Timeout.py#1 $
iNt TimeoutErrorc B s# e Z d Z d d Z d Z RS( s( Exception raised when a block times out.c O s; t t | j | | | d k r. d } n | | _ d S( Nt timeout( t superR t __init__t Nonet _msg( t selft msgt argst kwargs( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR s c C s | j S( N( R ( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __str__% s N( t __name__t
__module__t __doc__R R R
( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR s t Timeoutc B s5 e Z d Z d Z d Z d d Z d Z RS( s Context manager for running a block of commands under a timeout.
If the block times out, a TimeoutError is raised.
Arguments:
seconds (int) - timeout in seconds
msg (str) - message to supply to TimeoutError
c s5 t j t j f d _ t j j S( Nc s
j S( N( t _timeout( t _signumt _frame( R ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt ; s ( t signalt SIGALRMt _Timeout__oldHandlert alarmt _Timeout__seconds( R ( ( R s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __enter__8 s c C s' t j d t j t j | j t S( Ni ( R R R R t False( R t
exceptionTypet exceptionValuet traceback( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __exit__A s
c C s | | _ | | _ d | _ d S( N( R t
_Timeout__msgR R ( R t secondsR ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR J s c C s t | j d S( s+ Method invoked if the alarm goes off.
N( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR R s N( R R R
R R R R R ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR ) s
( R
R t ExceptionR t objectR ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt s Transaction.py 0000644 00000016245 14722167475 0007432 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
Transaction - provides transactional support
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Transaction.py#1 $
"""
from functools import wraps
import gettext
import sys
import threading
gettext.install('Transaction')
class Transaction(object):
"""Client-visible transaction object.
"""
# A dictionary mapping thread identifier to a list of the thread's
# transactions.
__transactionLists = {}
######################################################################
# Public methods
######################################################################
@classmethod
def transaction(cls):
"""Returns the current transaction for the current thread.
"""
return cls._threadTransactionList()[-1]
######################################################################
def addUndoStage(self, undoStage):
"""Adds callable undoStage to transaction stages.
Arguments:
undoStage (callable) - callable to execute as part of
transaction roll-back
"""
self.__undoStages.append(undoStage)
######################################################################
def setMessage(self, handleMessage, message = None):
"""Sets the message to handle if there is an exception.
If message is specified and an exception occurs the exception
will be appended to the message using "; {0}" where "{0}" represents
the exception.
If message is not specified, the exception will be coerced to
a string and passed to handleMessage.
Specifying handleMessage as None will clear both handleMessage and
message.
Arguments:
handleMessage (callable) - method to handle message
message (string) - message
"""
raise NotImplementedError
######################################################################
# Overridden methods
######################################################################
def __init__(self):
super(Transaction, self).__init__()
self.__undoStages = []
######################################################################
# Protected methods
######################################################################
@classmethod
def _threadTransactionList(cls):
"""Returns the transaction list for the current thread, creating it
if need be.
Returns:
list of Transactions
"""
transactionList = None
threadId = threading.currentThread().ident
try:
transactionList = cls.__transactionLists[threadId]
except KeyError:
transactionList = []
cls.__transactionLists[threadId] = transactionList
return transactionList
######################################################################
def _undoStages(self):
"""Returns the list of undo stages for the transaction.
Returns:
list of undo stages
"""
return self.__undoStages
######################################################################
# Private methods
######################################################################
########################################################################
def transactional(func):
"""Method decorator providing transactional capabilities to the method.
"""
######################################################################
class _Transaction(Transaction):
"""Decorator-local transaction object providing actual transaction
capabilities.
"""
####################################################################
# Public methods
####################################################################
@classmethod
def addTransaction(cls):
"""Adds, and returns, a transaction to the transaction list for the
current thread.
"""
cls._threadTransactionList().append(cls())
return cls.transaction()
####################################################################
@classmethod
def removeTransaction(cls):
"""Removes the current transaction for for the current thread.
"""
cls._threadTransactionList().pop()
####################################################################
def undo(self, exception):
"""Performs the undo processing of the transaction.
Exceptions from the undo stages are ignored.
Arguments:
exception - the exception which resulted in undo being called
"""
# Handle any message that was set for the transaction.
if self.__handleMessage is not None:
if self.__message is not None:
self.__handleMessage(_("{0}; {1}").format(self.__message,
str(exception)))
else:
self.__handleMessage(str(exception))
# Perform the undo processing.
undoStages = self._undoStages()[:]
undoStages.reverse()
for undoStage in undoStages:
try:
undoStage()
except Exception:
pass
####################################################################
# Overridden methods
####################################################################
def __init__(self):
super(_Transaction, self).__init__()
self.__handleMessage = None
self.__message = None
####################################################################
def setMessage(self, handleMessage, message = None):
self.__handleMessage = handleMessage
if self.__handleMessage is None:
self.__message = None
else:
self.__message = message
####################################################################
# Protected methods
####################################################################
####################################################################
# Private methods
####################################################################
######################################################################
@wraps(func)
def wrap(*args, **kwargs):
"""Wrapper method providing transactional processing capabilities.
"""
transaction = _Transaction.addTransaction()
result = None
try:
result = func(*args, **kwargs)
except Exception as ex:
transaction.undo(ex)
# Re-raise the Exception, preserving the stack trace from its origin.
#pylint: disable=E0710
raise type(ex), ex, sys.exc_info()[2]
finally:
_Transaction.removeTransaction()
return result
return wrap
FileUtils.py 0000644 00000035530 14722167475 0007043 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
FileUtils - Provides dmmgmnt file-related capabilities.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/FileUtils.py#1 $
"""
from __future__ import print_function
import errno
import fcntl
import gettext
import grp
import logging
import os
import stat
import tempfile
import time
from .Command import Command
from .Timeout import Timeout, TimeoutError
gettext.install("utils")
########################################################################
class FileBase(object):
"""The FileBase object; provides basic file control.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
"""
log = logging.getLogger('utils.FileBase')
######################################################################
# Public methods
######################################################################
@property
def path(self):
return self.__filePath
######################################################################
# Overridden methods
######################################################################
def __init__(self, filePath, *args, **kwargs):
"""
Arguments:
None
Returns:
Nothing
"""
super(FileBase, self).__init__()
self.__filePath = os.path.realpath(filePath)
self.__fd = kwargs.get("fd", None)
######################################################################
def __enter__(self):
return self
######################################################################
def __exit__(self, exceptionType, exceptionValue, traceback):
# Don't suppress exceptions.
return False
######################################################################
# Protected methods
######################################################################
@property
def _fd(self):
return self.__fd
######################################################################
# pylint: disable=E0102
# pylint: disable=E1101
@_fd.setter
def _fd(self, value):
self.__fd = value
######################################################################
# Private methods
######################################################################
########################################################################
class FileTouch(FileBase):
"""The FileTouch object; touches the file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
"""
log = logging.getLogger('utils.FileTouch')
######################################################################
# Public methods
######################################################################
######################################################################
# Overridden methods
######################################################################
def __init__(self, filePath, *args, **kwargs):
"""
Arguments:
None
Returns:
Nothing
"""
super(FileTouch, self).__init__(filePath, *args, **kwargs)
######################################################################
def __enter__(self):
"""Make certain the file exists and return ourself."""
super(FileTouch, self).__enter__()
if self._fd is None:
# Make certain the file exists and that we have access to it.
dirPath = os.path.dirname(self.path)
# Make certain the directory exists.
# N.B.: The names may not be sanitized for use with a shell!
if not os.access(dirPath, os.F_OK):
cmd = Command(["mkdir", "-p", dirPath])
cmd.run()
# Make certain the target exists.
if not os.access(self.path, os.F_OK):
self._createFile()
return self
######################################################################
# Protected methods
######################################################################
def _createFile(self):
"""Creates the targe file."""
# N.B.: The names may not be sanitized for use with a shell!
cmd = Command(["touch", self.path])
cmd.run()
######################################################################
# Private methods
######################################################################
########################################################################
class FileOpen(FileTouch):
"""The FileOpen object; provides basic access to a file.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
"""
log = logging.getLogger('utils.FileOpen')
######################################################################
# Public methods
######################################################################
@property
def file(self):
return self.__file
######################################################################
def flush(self):
self.file.flush()
######################################################################
def read(self, numberOfBytes = -1):
return self.file.read(numberOfBytes)
######################################################################
def readline(self, numberOfBytes = -1):
return self.file.readline(numberOfBytes)
######################################################################
def readlines(self, numberOfBytesHint = None):
# The documentation for readlines is not consistent with the other
# read methods as to what constitutes a valid default parameter.
# Testing shows that neither None nor -1 are acceptable so we
# use None and specifically check for it.
if numberOfBytesHint is None:
return self.file.readlines()
else:
return self.file.readlines(numberOfBytesHint)
######################################################################
def seek(self, offset, whence = os.SEEK_SET):
self.file.seek(offset, whence)
######################################################################
def truncate(self, size = None):
# The documentation for truncate indicates that without an argument
# it truncates to the current file position. Testing shows that
# neither None nor -1 are acceptable as parameters so we use None
# and specifically check for it.
if size is None:
self.file.truncate()
else:
self.file.truncate(size)
######################################################################
def write(self, string):
self.file.write(string)
######################################################################
def writelines(self, sequenceOfStrings):
self.file.writeline(sequenceOfStrings)
######################################################################
# Overridden methods
######################################################################
def next(self):
return self.file.next()
######################################################################
def __enter__(self):
"""Open the file and return ourself."""
super(FileOpen, self).__enter__()
if self._fd is None:
self._fd = os.open(self.path, self._osMode)
self.__file = os.fdopen(self._fd, self.__mode)
return self
######################################################################
def __exit__(self, exceptionType, exceptionValue, traceback):
""" Close the file."""
self.file.close()
return super(FileOpen, self).__exit__(exceptionType,
exceptionValue,
traceback)
######################################################################
def __init__(self, filePath, mode = "r", *args, **kwargs):
"""
Arguments:
None
Returns:
Nothing
"""
super(FileOpen, self).__init__(filePath, *args, **kwargs)
osMode = None
if (len(mode) > 1) and ("+" in mode[1:]):
osMode = os.O_RDWR
elif mode[0] == "r":
osMode = os.O_RDONLY
elif mode[0] == "w":
osMode = os.O_WRONLY | os.O_TRUNC
else:
osMode = os.O_RDWR
if mode[0] == "a":
osMode = osMode | os.O_APPEND
self.__file = None
self.__mode = mode
self.__osMode = osMode
######################################################################
def __iter__(self):
return self
######################################################################
# Protected methods
######################################################################
@property
def _osMode(self):
return self.__osMode
######################################################################
# Private methods
######################################################################
########################################################################
class FileLock(FileOpen):
"""The FileLock object; a context manager providing interlocked access on
a file.
The file is created, if necessary.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
_timeout - timeout in seconds (None = no timeout)
"""
log = logging.getLogger('utils.FileLock')
######################################################################
# Public methods
######################################################################
######################################################################
# Overridden methods
######################################################################
def __init__(self, filePath, mode, timeout=None, *args, **kwargs):
"""
Arguments:
filePath - (str) path to file
mode - (str) open mode
timeout - (int) timeout in seconds; may be None
Returns:
Nothing
"""
super(FileLock, self).__init__(filePath, mode)
self._timeout = timeout
######################################################################
def __enter__(self):
"""If the open mode is read-only the file is locked shared else it is
locked exclusively.
"""
super(FileLock, self).__enter__()
if self._osMode == os.O_RDONLY:
flockMode = fcntl.LOCK_SH
lockModeString = "shared"
else:
flockMode = fcntl.LOCK_EX
lockModeString = "exclusive"
if self._timeout is not None:
self.log.debug("attempting to lock {f} in {s}s mode {m}"
.format(f=self.path,
s=self._timeout,
m=lockModeString))
with Timeout(self._timeout, _(
"Could not lock {f} in {s} seconds").format(f=self.path,
s=self._timeout)):
fcntl.flock(self.file, flockMode)
else:
self.log.debug("attempting to lock {f} mode {m}"
.format(f=self.path,
m=lockModeString))
fcntl.flock(self.file, flockMode)
return self
######################################################################
def __exit__(self, exceptionType, exceptionValue, traceback):
""" Unlocks and closes the file."""
fcntl.flock(self.file, fcntl.LOCK_UN)
if exceptionType is not TimeoutError:
self.log.debug("released lock {f}".format(f=self.path))
return super(FileLock, self).__exit__(exceptionType,
exceptionValue,
traceback)
######################################################################
# Protected methods
######################################################################
######################################################################
# Private methods
######################################################################
########################################################################
class FileTemp(FileOpen):
"""The FileTemp object; a context manager providing temporary files
with specified (or default) owner and permissions.
An optional destination parameter specifies the location to which the
temp file should be moved at exit, if no exception is encountered.
The move, if specified, is performed after performing the owner
manipulations.
Class attributes:
log (logging.Logger) - logger for this class
Attributes:
None
"""
log = logging.getLogger('utils.FileTemp')
######################################################################
# Public methods
######################################################################
######################################################################
# Overridden methods
######################################################################
def __init__(self, owner = None, ownerPerm = None, destination = None,
*args, **kwargs):
"""
Arguments:
owner - (str) the owner to set for the file
ownerPerm - (str) the permissions to set for the owner
destination (str) the path to which to move the temp file on exit
Returns:
Nothing
"""
tmpFile = tempfile.mkstemp()
super(FileTemp, self).__init__(tmpFile[1], "r+", fd = tmpFile[0])
if not owner:
owner = str(os.geteuid())
if not ownerPerm:
ownerPerm = "rw"
self.__owner = owner
self.__ownerPerm = ownerPerm
self.__destination = destination
######################################################################
def __exit__(self, exceptionType, exceptionValue, traceback):
exception = exceptionType
if (exception is None) and (self.__destination is not None):
try:
cmd = Command(["chown", self.__owner, self.path])
cmd.run()
cmd = Command(["chmod", "=".join(["u", self.__ownerPerm]), self.path])
cmd.run()
self.file.close() # need to close the file to save data before move.
cmd = Command(["mv", self.path, self.__destination])
cmd.run()
except Exception as ex:
exception = ex
if (exception is not None) or (self.__destination is None):
try:
cmd = Command(["rm", self.path])
cmd.run()
except:
pass
return super(FileTemp, self).__exit__(exceptionType,
exceptionValue,
traceback)
######################################################################
# Protected methods
######################################################################
######################################################################
# Private methods
######################################################################
Logger.py 0000644 00000010457 14722167475 0006363 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
Logger - VDO manager logging
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Logger.py#3 $
"""
import logging
import logging.handlers
import os
import sys
from types import MethodType
class Logger(object):
"""Wrappers and configuration methods for the Python logger.
Attributes:
logfile (string): the path to the logfile if specified.
myname (string): name of the command being run.
quiet (bool): if True, don't print to stdout.
"""
myname = os.path.basename(sys.argv[0])
quiet = False
logfile = None
######################################################################
# Public methods
######################################################################
@classmethod
def announce(cls, logger, msg):
"""Print a status message to stdout and log it as well."""
if not cls.quiet:
print(msg)
logger.info(msg)
######################################################################
@classmethod
def configure(cls, name, logfile = None, debug = False):
"""Configure the logging system according to the arguments."""
cls.myname = name
cls.logfile = logfile
debugging = debug
formatBase = ': %(levelname)s - %(message)s'
debugBase = (': %(name)s' if debugging else '') + formatBase
logger = logging.getLogger()
logger.setLevel(logging.NOTSET)
handler = logging.StreamHandler(sys.stderr)
handler.setFormatter(logging.Formatter(cls.myname + debugBase))
handler.setLevel(logging.DEBUG if debugging else logging.WARNING)
logger.addHandler(handler)
if cls.logfile is not None:
try:
if os.path.exists(cls.logfile) and not os.path.isfile(cls.logfile):
# Support /dev/stderr and the like.
logstream = open(cls.logfile, "w")
handler = logging.StreamHandler(stream=logstream)
else:
handler = logging.handlers.RotatingFileHandler(cls.logfile,
maxBytes=10*1024*1024,
backupCount=5)
formatter = logging.Formatter('%(asctime)s %(name)s' + formatBase)
handler.setFormatter(formatter)
handler.setLevel(logging.DEBUG if debugging else logging.INFO)
logger.addHandler(handler)
except Exception as ex:
logger.warn('Unable to configure logging to {logfile}: {ex}'
.format(logfile=cls.logfile, ex=ex))
try:
handler = logging.handlers.SysLogHandler(address='/dev/log')
handler.setFormatter(logging.Formatter(cls.myname + formatBase))
handler.setLevel(logging.WARNING)
logger.addHandler(handler)
except Exception as ex:
logger.warn('Unable to configure logging for rsyslog: {0}'.format(ex))
######################################################################
@classmethod
def getLogger(cls, name):
"""Returns a Python logger decorated with the announce method."""
logger = logging.getLogger(name)
logger.announce = MethodType(cls.announce, logger, logger.__class__)
return logger
######################################################################
@classmethod
def loggingOptions(cls):
"""Return a list of strings containing the logging options specified."""
options = [ ]
if cls.logfile is not None:
options.append("--logfile=" + str(cls.logfile))
return options
######################################################################
# Overridden methods
######################################################################
def __init__(self):
super(Logger, self).__init__()
Command.py 0000644 00000026673 14722167475 0006531 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
Command - runs commands and manages their results
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Command.py#3 $
"""
from .Logger import Logger
from subprocess import Popen, PIPE
import copy
import logging
import os
import pipes
import time
class CommandError(Exception):
"""Exception raised to indicate an error running a command.
Arguments:
exitCode (int): The exit code of the command
stdout (string): The output from the command
stderr (string): The error output from the command
message (string): The (localized) error text; will be formatted with
the remaining arguments
args: Arguments for formatting the message
"""
######################################################################
# Public methods
######################################################################
def getExitCode(self):
return self._exitCode
######################################################################
def getStandardError(self):
return self._stderr
######################################################################
def logOutputs(self, logMethod):
"""Log the outputs of the failed command which generated this exception.
Arguments:
logMethod (callable): The method to log with
"""
logMethod(self._stdout)
logMethod(self._stderr)
######################################################################
def setMessage(self, message, *args):
"""Set the error message in this exception.
Arguments:
message (string): The (localized) message text; will be formatted
with *args
args: Values to pass to the format of message
"""
self._message = message.format(*args)
######################################################################
# Overridden methods
######################################################################
def __init__(self, exitCode, stdout, stderr, message, *args):
super(CommandError, self).__init__()
self._exitCode = exitCode
self._stdout = stdout
self._stderr = stderr
self.setMessage(message, args)
######################################################################
def __str__(self):
return self._message
########################################################################
class Command(object):
"""Command encapsulates shell commands, runs them, and manages the result.
Attributes:
noRun (bool): if True, don't run the command, and always succeed
shell (bool): if True, run this command using shell -c
verbose (int): if > 0, print commands to stdout before executing them
_commandList (list): command and its arguments
"""
defaultNoRun = False
defaultVerbose = 0
log = logging.getLogger(Logger.myname + '.Command')
######################################################################
# Public methods
######################################################################
@classmethod
def noRunMode(cls):
"""Returns True iff Commands default to noRun."""
return cls.defaultNoRun
######################################################################
@classmethod
def setDefaults(cls, verbose = False, noRun = False):
"""Sets the verbose and noRun default values.
Arguments:
verbose: (boolean) If True, operate verbosely.
noRun: (boolean) If True, do not actually execute.
"""
if noRun:
cls.defaultNoRun = noRun
cls.defaultVerbose = True
if verbose:
cls.defaultVerbose = verbose
######################################################################
def commandName(self):
"""Returns an identifier (argv[0]) for error messages."""
return self._commandList[0]
######################################################################
def run(self, **kwargs):
"""Run a command.
Returns the output of running the command.
Arguments:
noThrow: If True, will return an empty string instead of throwing on
error.
retries: The number of times to try the command before giving up.
Defaults to 1.
shell: Indicate that this is a shell command
stdin: If not None, the stream from which the command should take
its input, defaults to None.
strip: If True, strip leading and trailing whitespace from the
command output before returning it.
Exceptions:
CommandError: if the command failed and noThrow is False
"""
retries = kwargs.get('retries', 1)
stdin = kwargs.get('stdin', None)
if not self.shell:
self.shell = kwargs.get('shell', False)
commandLine = self._getCommandLine()
if retries > 1:
self.log.debug("Waiting for '{0}'".format(commandLine))
try:
for count in range(retries):
if retries > 1:
self.log.debug(" ... {0}/{1}".format(count, retries))
if self.verbose > 0:
print(' ' + commandLine)
self.log.info(commandLine)
if self.noRun:
return
try:
output = self._execute(stdin)
return output.strip() if kwargs.get('strip', False) else output
except CommandError as e:
if count == (retries - 1):
if retries > 1:
e.setMessage(_("{0}: timed out after {1} seconds"),
self.commandName(), retries)
raise e
time.sleep(1)
except CommandError as e:
if kwargs.get('noThrow', False):
return ''
raise e
######################################################################
# Overridden methods
######################################################################
def __init__(self, commandList, environment=None):
super(Command, self).__init__()
self.noRun = Command.defaultNoRun
self.shell = False
self.verbose = Command.defaultVerbose
self._commandList = commandList
if environment:
self.env = copy.deepcopy(os.environ)
for var, value in environment.items():
self.env[var] = value
else:
self.env = None
######################################################################
def __str__(self):
' '.join(self._commandList)
######################################################################
# Protected methods
######################################################################
def _checkResults(self, exitCode=0, stdout='', stderr=''):
"""Sets the result values of this object. Raises an exception if there was
an error, or returns the output of the command if there was not.
Arguments:
exitCode (int): the process exit code
stdout (str): the standard output
stderr (str): the standard error
logResults (bool): if True, the results will be logged
Exceptions:
CommandError: if exitCode is non-zero
"""
try:
if (exitCode == 0):
self.log.debug(_("{0}: command succeeded").format(self.commandName()))
return stdout
failureType = _('exit status') if exitCode > 0 else _('signal')
status = _("{0}: command failed, {1} {2}").format(self.commandName(),
failureType,
abs(exitCode))
self.log.debug(status)
raise CommandError(exitCode, stdout, stderr, status)
finally:
self.log.debug('stdout: ' + stdout.rstrip())
self.log.debug('stderr: ' + stderr.rstrip())
######################################################################
def _execute(self, stdin):
"""Execute the command once.
Returns the output of the command.
Arguments:
stdin: If not None, the stream from which the command should take its
input.
Exceptions:
CommandError: if the command failed
"""
command = self._getCommandLine() if self.shell else self._commandList
try:
p = Popen(command,
stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True,
env=self.env, shell=self.shell)
stdoutdata, stderrdata = p.communicate(stdin)
return self._checkResults(p.returncode, "".join(stdoutdata),
"".join(stderrdata))
except OSError as e:
self._checkResults(e.errno, '',
': '.join([self.commandName(), e.strerror]))
except CommandError as e:
error = e._stderr.split(os.linesep)[0]
if error:
e.setMessage(error)
raise e
######################################################################
def _getCommandLine(self):
"""Returns the appropriately quoted command line."""
return ' '.join(self._commandList if self.shell
else map(pipes.quote, self._commandList))
########################################################################
def runCommand(commandList, **kwargs):
"""Run a command.
Returns the output of the command (but see Keyword Arguments).
Arguments:
commandList: The command as a list of strings.
Keyword Arguments:
environment: A dict of environment variables and their values to use for
the command.
noThrow: If True, will return an empty string instead of throwing on
error.
retries: The number of times to try the command before giving up.
Defaults to 1.
shell: Indicate that this is a shell command.
stdin: If not None, the stream from which the command should take its
input, defaults to None.
strip: If True, strip leading and trailing whitespace from the
command output before returning it.
Exceptions:
CommandError: if the command failed and noThrow is False
"""
return Command(commandList, kwargs.pop('environment', None)).run(**kwargs)
########################################################################
def tryCommandsUntilSuccess(commands, **kwargs):
"""Try each of a series of commands in turn until one succeeds. If all the
commands fail, give up and raise an exception.
Arguments:
commands: A list of command lists
Keyword Arguments:
Supports all of the arguments which may be passed to runCommand().
Returns:
the output of the first successful command
Exceptions:
CommandError: if none of the commands succeeds and the noThrow keyword
option is False (or omitted); the error will be the one
raised by the last command in the list
"""
error = None
noThrow = kwargs.pop('noThrow', False)
for command in commands:
try:
return runCommand(command, **kwargs)
except CommandError as e:
error = e
if noThrow:
error = None
# Pylint thinks we can raise None here.
if error is not None:
#pylint: disable=E0702
raise error
Timeout.pyc 0000644 00000005215 14722167475 0006731 0 ustar 00
.t_c @ sB d Z d d l Z d e f d YZ d e f d YZ d S( s
Timeout - context manager that implements a timeout.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Timeout.py#1 $
iNt TimeoutErrorc B s# e Z d Z d d Z d Z RS( s( Exception raised when a block times out.c O s; t t | j | | | d k r. d } n | | _ d S( Nt timeout( t superR t __init__t Nonet _msg( t selft msgt argst kwargs( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR s c C s | j S( N( R ( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __str__% s N( t __name__t
__module__t __doc__R R R
( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR s t Timeoutc B s5 e Z d Z d Z d Z d d Z d Z RS( s Context manager for running a block of commands under a timeout.
If the block times out, a TimeoutError is raised.
Arguments:
seconds (int) - timeout in seconds
msg (str) - message to supply to TimeoutError
c s5 t j t j f d _ t j j S( Nc s
j S( N( t _timeout( t _signumt _frame( R ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt ; s ( t signalt SIGALRMt _Timeout__oldHandlert alarmt _Timeout__seconds( R ( ( R s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __enter__8 s c C s' t j d t j t j | j t S( Ni ( R R R R t False( R t
exceptionTypet exceptionValuet traceback( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt __exit__A s
c C s | | _ | | _ d | _ d S( N( R t
_Timeout__msgR R ( R t secondsR ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR J s c C s t | j d S( s+ Method invoked if the alarm goes off.
N( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR R s N( R R R
R R R R R ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyR ) s
( R
R t ExceptionR t objectR ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Timeout.pyt s Transaction.pyc 0000644 00000013715 14722167475 0007574 0 ustar 00
.t_c @ sj d Z d d l m Z d d l Z d d l Z d d l Z e j d d e f d YZ d Z d S( s~
Transaction - provides transactional support
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Transaction.py#1 $
i( t wrapsNt Transactionc B sY e Z d Z i Z e d Z d Z d d Z d Z e d Z
d Z RS( s% Client-visible transaction object.
c C s | j d S( s< Returns the current transaction for the current thread.
i( t _threadTransactionList( t cls( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt transaction- s c C s | j j | d S( s Adds callable undoStage to transaction stages.
Arguments:
undoStage (callable) - callable to execute as part of
transaction roll-back
N( t _Transaction__undoStagest append( t selft undoStage( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt addUndoStage4 s c C s
t d S( s+ Sets the message to handle if there is an exception.
If message is specified and an exception occurs the exception
will be appended to the message using "; {0}" where "{0}" represents
the exception.
If message is not specified, the exception will be coerced to
a string and passed to handleMessage.
Specifying handleMessage as None will clear both handleMessage and
message.
Arguments:
handleMessage (callable) - method to handle message
message (string) - message
N( t NotImplementedError( R t
handleMessaget message( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt
setMessage> s c C s t t | j g | _ d S( N( t superR t __init__R ( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR T s c C sQ d } t j j } y | j | } Wn$ t k
rL g } | | j | d t f f d Y t f d } | S( sG Method decorator providing transactional capabilities to the method.
t _Transactionc sP e Z d Z e d Z e d Z d Z f d Z d d Z RS( sY Decorator-local transaction object providing actual transaction
capabilities.
c S s | j j | | j S( s` Adds, and returns, a transaction to the transaction list for the
current thread.
( R R R ( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt addTransaction s c S s | j j d S( sB Removes the current transaction for for the current thread.
N( R t pop( R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt removeTransaction s c S s | j d k r_ | j d k rI | j t d j | j t | q_ | j t | n | j } | j x- | D]% } y | Wq} t k
r q} Xq} Wd S( s Performs the undo processing of the transaction.
Exceptions from the undo stages are ignored.
Arguments:
exception - the exception which resulted in undo being called
s {0}; {1}N( t _Transaction__handleMessageR t _Transaction__messaget _t formatt strR t reverset Exception( R t exceptiont
undoStagesR ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt undo s
c s) t | j d | _ d | _ d S( N( R R R R! R" ( R ( R ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR s c S s1 | | _ | j d k r$ d | _ n | | _ d S( N( R! R R" ( R R R ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR
s N(
R R R R R R R* R R R
( ( R ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyR s c sz j } d } zV y | | } Wn< t k
rf } | j | t | | t j d n XWd j X| S( sD Wrapper method providing transactional processing capabilities.
i N( R R R' R* t typet syst exc_infoR ( t argst kwargsR t resultt ex( R t func( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt wrap s
$ ( R R ( R2 R3 ( ( R R2 s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt
transactionalz s J (
R t functoolsR t gettextR, R t installt objectR R4 ( ( ( s9 /usr/lib/python2.7/site-packages/vdo/utils/Transaction.pyt s
X __init__.pyo 0000644 00000074057 14722167475 0007070 0 ustar 00
;Xc @ sb d Z d d l m Z d d l m Z m Z m Z d d l m Z m
Z
d d l Z d d l m
Z d d l m Z d d l Z d d l Z d d l Z e j e Z d d l Z d d l Z d d l Z d d l Z d d l Z e r y d d l Z Wq(e k
rd Z d Z q(Xn d d l Z d d l Z e rId d l! Z! n d d l" Z" d d l# m$ Z$ d d
l% m& Z& m' Z' m( Z( m) Z) m* Z* m+ Z+ m, Z, m- Z- m. Z. m/ Z/ m0 Z0 m1 Z1 m2 Z2 d d l3 m4 Z4 m5 Z5 m6 Z6 m7 Z7 m8 Z8 d d l9 m: Z: d d
l m; Z; m< Z< m= Z= m> Z> m? Z? m@ Z@ mA ZA mB ZB mC ZC mD ZD mE ZE mF ZF mG ZG mH ZH mI ZI d d d d d d d d d d d d d d d d d d d d! d" d# d$ d% d& g ZJ eK e j eA re jL n e jM d' d( ZN d) d* d+ d, d- d. d/ g ZO d0 d1 g ZP d d2 l9 mQ ZQ d3 ZR eB d3 ZS eB d4 ZT eK e jU jV d5 pEd6 ZW d7 eX f d8 YZY eA re jZ j[ Z\ e] e\ e jZ j^ g Z_ d9 Z` n d: Z` d d ea d d ea d; Zb d< Zc d= Zd ed Ze y d d> lf mg Zd Wn e k
rn Xd? d@ Zh dA dB Zi e d k r.dA dC Zi n dD Zj eA rRdE Zk dF Zl n( d dG l mm Zm mn Zn dH Zk dI Zl e; ek dJ e; el dK dL Zo dM Zp dN Zq eB dN Zr d dO Zs dP Zt et ju dQ Zv dR Zw dS Zx d Zy eB dT Zz dV Z{ dW dA d dX Z| dW dA dY Z} eA r?dW dA dZ Z~ n dW dA d[ Z~ e; e~ d\ e4 d] d^ d_ d` dQ da Z e] db j Z e] dc j Z e] d3 dd g Z d de df Z y d dg l m Z Wn& e k
rd Z ea Z dh Z n4 Xe Z dN Z eB di Z eA r(dj Z n dk Z e; e dl dm Z e j dn k rid do l m Z n d dp l m Z e Z dq Z y e j dr e Z Wn e k
rea Z n Xd ds Z e re j Z n e j e Z dt Z du Z dv Z e4 d] d` d_ dw dx dy dz e d{ Z d Z d Z d Z d Z d Z d Z d S( s4 passlib.utils -- helpers for writing password hashesi( t JYTHON( t
b2a_base64t
a2b_base64t Error( t b64encodet b64decodeN( t lookup( t update_wrappers not present under Jython( t warn(
t BASE64_CHARSt
AB64_CHARSt HASH64_CHARSt BCRYPT_CHARSt Base64Enginet LazyBase64Enginet h64t h64bigt bcrypt64t ab64_encodet ab64_decodet b64s_encodet b64s_decode( t deprecated_functiont deprecated_methodt memoized_propertyt
classpropertyt
hybrid_method( t ExpectedStringError( t add_doct
join_bytest join_byte_valuest join_byte_elemst iranget imapt PY3t ut join_unicodet unicodet byte_elem_valuet
nextgettert unicode_or_bytes_typest get_method_functiont suppress_causeR t sys_bitst unix_crypt_schemest rounds_cost_valuest consteqt saslprept xor_bytest render_bytest
is_same_codect
is_ascii_safet to_bytest
to_unicodet
to_native_strt has_cryptt
test_cryptt
safe_cryptt tickt rngt getrandbytest
getrandstrt generate_passwordt is_crypt_handlert is_crypt_contextt has_rounds_infot
has_salt_infoi g ?t sha512_cryptt sha256_cryptt
sha1_cryptt bcryptt md5_cryptt
bsdi_cryptt des_cryptt lineart log2( t MissingBackendErrort t t PASSLIB_MAX_PASSWORD_SIZEi t
SequenceMixinc B sM e Z d Z d Z d Z d Z d Z d Z d Z d Z RS( s
helper which lets result object act like a fixed-length sequence.
subclass just needs to provide :meth:`_as_tuple()`.
c C s t d d S( Ns implement in subclass( t NotImplemented( t self( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt _as_tuple s c C s t | j S( N( t reprRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __repr__ s c C s | j | S( N( RS ( RR t idx( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __getitem__ s c C s t | j S( N( t iterRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __iter__ s c C s t | j S( N( t lenRS ( RR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __len__ s c C s | j | k S( N( RS ( RR t other( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __eq__ s c C s | j | S( N( R] ( RR R\ ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt __ne__ s (
t __name__t
__module__t __doc__RS RU RW RY R[ R] R^ ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRP s c C se t j t | j } | s" t S| j | } | rJ | j t k rJ t S| t | d j t
k S( s* test if function accepts specified keywordi( t inspectt signatureR) t
parameterst Falset gett kindt _VAR_ANY_SETt Truet listt _VAR_KEYWORD( t funct keyt paramst arg( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt accepts_keyword s c C s1 t j t | } | | j k p0 | j d k S( s* test if function accepts specified keywordN( Rb t
getargspecR) t argst keywordst None( Rl Rm t spec( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRp s c s t | t r | g } n t | j } | r t | t rK | g } n xE | D]: | rp | k rp qR n | k rR | j qR qR Wn | rx | D] t f d | D r q n | r&x t | D]8 \ } } t | r Pn | r t | | r Pq q Wt | } n[ | r{xR t t | D]/ \ }
} t | | r?t | |
} Pq?q?Wd } n d } | j
| q Wn | st | | _ n d S( s
helper to update mixin classes installed in target class.
:param target:
target class whose bases will be modified.
:param add:
class / classes to install into target's base class list.
:param remove:
class / classes to remove from target's base class list.
:param append:
by default, prepends mixins to front of list.
if True, appends to end of list instead.
:param after:
optionally make sure all mixins are inserted after
this class / classes.
:param before:
optionally make sure all mixins are inserted before
this class / classes.
:param dryrun:
optionally perform all calculations / raise errors,
but don't actually modify the class.
c 3 s | ] } t | Vq d S( N( t
issubclass( t .0t base( t mixin( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s i N( t
isinstancet typeRj t __bases__t removet anyt enumerateRv RZ t reversedt insertt tuple( t targett addR} t appendt beforet aftert dryrunt basesRV Rx t end_idx( ( Ry s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt update_mixin_classes s@
c c s | d k r t d n t | t j rq t | } d } x | | k rm | | } | | | !V| } qB Wn t | t j r t | } xd t r t j | | } y t
| } Wn t k
r Pn Xt j | f | Vq Wn t
d d S( s8
split iterable into chunks of elements.
i s size must be positive integeri s source must be iterableN( t
ValueErrorRz t collectionst SequenceRZ t IterableRX Ri t itertoolst islicet nextt
StopIterationt chaint TypeError( t sourcet sizet endt it nt itrt chunk_itrt first( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt batch s&
c C s5 t | t r6 t | t s- t d n t } nB t | t rl t | t sc t d n t } n t d t | t | k } | r | } d } n | s | } d } n | r xh t | | D] \ } } | | | AO} q Wn: x7 t | | D]& \ } } | t | t | AO} qW| d k S( s Check two strings/bytes for equality.
This function uses an approach designed to prevent
timing analysis, making it appropriate for cryptography.
a and b must both be of the same type: either str (ASCII only),
or any type that supports the buffer protocol (e.g. bytes).
Note: If a and b are of different lengths, or if an error occurs,
a timing attack could theoretically reveal information about the
types and lengths of a and b--but not their values.
s) inputs must be both unicode or both bytesi i ( Rz R% R Re t bytesR" RZ t zipt ord( t leftt rightt is_py3_bytest same_sizet tmpt resultt lt r( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR. / s, ( t compare_digestt ,c C sX | j } | j | r( | d } n | s2 g Sg | j | D] } | j ^ qB S( sR split comma-separated string into list of elements,
stripping whitespace.
i( t stript endswitht split( R t sept elem( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
splitcommaz s
t valuec sb t | t s+ t d t | f n t j t j t f d | D } t j d | } | sx t
St j } | | d r | | d s t d | n t j
} n | } t j } t j } t j } t j } t j } t j }
t j } t j } t j }
xD| D]<} | | rCt d | n | | rbt d | n | | rt d | n | | rt d
| n | | rt d | n |
| rt d | n | | rt d
| n | | r t d | n |
| r;t d | n | | r t d | q q W| S( s Normalizes unicode strings using SASLPrep stringprep profile.
The SASLPrep profile is defined in :rfc:`4013`.
It provides a uniform scheme for normalizing unicode usernames
and passwords before performing byte-value sensitive operations
such as hashing. Among other things, it normalizes diacritic
representations, removes non-printing characters, and forbids
invalid characters such as ``\n``. Properly internationalized
applications should run user passwords through this function
before hashing.
:arg source:
unicode string to normalize & validate
:param param:
Optional noun identifying source parameter in error messages
(Defaults to the string ``"value"``). This is mainly useful to make the caller's error
messages make more sense contextually.
:raises ValueError:
if any characters forbidden by the SASLPrep profile are encountered.
:raises TypeError:
if input is not :class:`!unicode`
:returns:
normalized unicode string
.. note::
This function is not available under Jython,
as the Jython stdlib is missing the :mod:`!stringprep` module
(`Jython issue 1758320 `_).
.. versionadded:: 1.6
s$ input must be unicode string, not %sc 3 s3 | ]) } | s | r' t n | Vq d S( N( t _USPACE( Rw t c( t in_table_b1t in_table_c12( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s t NFKCi is malformed bidi sequence in s$ unassigned code points forbidden in s control characters forbidden in s$ private use characters forbidden in s" non-char code points forbidden in s surrogate codes forbidden in s! non-plaintext chars forbidden in s! non-canonical chars forbidden in s1 display-modifying / deprecated chars forbidden ins tagged characters forbidden in s forbidden bidi character in ( Rz R% R R{ t
stringprepR R R$ t unicodedatat normalizet _UEMPTYt in_table_d1R t in_table_d2t in_table_a1t in_table_c21_c22t in_table_c3t in_table_c4t in_table_c5t in_table_c6t in_table_c7t in_table_c8t in_table_c9( R t paramt datat is_ral_chart is_forbidden_bidi_charR R R R R R R R R R ( ( R R s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR/ sb ,
c C s t d t d S( s stub for saslprep()s> saslprep() support requires the 'stringprep' module, which is N( t NotImplementedErrort _stringprep_missing_reason( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR/ s c G sH t | t r! | j d } n | t d | D } | j d S( s& Peform ``%`` formating using bytes in a uniform manner across Python 2/3.
This function is motivated by the fact that
:class:`bytes` instances do not support ``%`` or ``{}`` formatting under Python 3.
This function is an attempt to provide a replacement:
it converts everything to unicode (decoding bytes instances as ``latin-1``),
performs the required formatting, then encodes the result to ``latin-1``.
Calling ``render_bytes(source, *args)`` should function roughly the same as
``source % args`` under Python 2.
s latin-1c s s3 | ]) } t | t r' | j d n | Vq d S( s latin-1N( Rz R t decode( Rw Ro ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( Rz R R R t encode( R Rr R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR1 s
c C s t j | d S( Nt big( t intt
from_bytes( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt bytes_to_int" s c C s | j | d S( NR ( R4 ( R t count( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt int_to_bytes$ s ( t hexlifyt unhexlifyc C s t t | d S( Ni ( R R ( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR ) s c C s t d | d >| S( Ns %%0%dxi ( R ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR + s s/ decode byte string as single big-endian integers/ encode integer as single big-endian byte stringc C s# t t | t | At | S( s; Perform bitwise-xor of two byte strings (must be same size)( R R RZ ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR0 1 s c C sB t | } | | k r6 | | d | } | | | S| | Sd S( s; repeat or truncate string, so it has length i N( RZ ( R R t curt mult( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
repeat_string5 s
t c C s^ t | } | | k rR | d k rB t | t r9 t n t } n | | | | S| | Sd S( s> right-pad or truncate string, so it has length N( RZ Rt Rz R% t _UNULLt _BNULL( R R t padR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt right_pad_stringA s t
aA:#!t asciic C s t j | t k S( sR Test if codec is compatible with 7-bit ascii (e.g. latin-1, utf-8; but not utf-16)( t _ASCII_TEST_UNICODER t _ASCII_TEST_BYTES( t codec( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt is_ascii_codecQ s c C s< | | k r t S| o | s t St | j t | j k S( s3 Check if two codec names are aliases for same codec( Ri Re t
_lookup_codect name( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR2 U s
s i c s5 t | t r t n t t f d | D S( s< Check if string (bytes or unicode) contains only 7-bit asciic 3 s | ] } | k Vq d S( N( ( Rw R ( R ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys b s ( Rz R t _B80t _U80t all( R ( ( R s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR3 _ s s utf-8c C sq t | t rB | r; t | | r; | j | j | S| Sn+ t | t r^ | j | St | | d S( s Helper to normalize input to bytes.
:arg source:
Source bytes/unicode to process.
:arg encoding:
Target encoding (defaults to ``"utf-8"``).
:param param:
Optional name of variable/noun to reference when raising errors
:param source_encoding:
If this is specified, and the source is bytes,
the source will be transcoded from *source_encoding* to *encoding*
(via unicode).
:raises TypeError: if source is not unicode or bytes.
:returns:
* unicode strings will be encoded using *encoding*, and returned.
* if *source_encoding* is not specified, byte strings will be
returned unchanged.
* if *source_encoding* is specified, byte strings will be transcoded
to *encoding*.
N( Rz R R2 R R R% R ( R t encodingR t source_encoding( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR4 d s
c C sB t | t r | St | t r/ | j | St | | d S( s Helper to normalize input to unicode.
:arg source:
source bytes/unicode to process.
:arg encoding:
encoding to use when decoding bytes instances.
:param param:
optional name of variable/noun to reference when raising errors.
:raises TypeError: if source is not unicode or bytes.
:returns:
* returns unicode strings unchanged.
* returns bytes strings decoded using *encoding*
N( Rz R% R R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR5 s
c C sB t | t r | j | St | t r/ | St | | d S( N( Rz R R R% R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR6 s
c C sB t | t r | St | t r/ | j | St | | d S( N( Rz R R% R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR6 s
s> Take in unicode or bytes, return native string.
Python 2: encodes unicode using specified encoding, leaves bytes alone.
Python 3: leaves unicode alone, decodes bytes using specified encoding.
:raises TypeError: if source is not unicode or bytes.
:arg source:
source unicode or bytes string.
:arg encoding:
encoding to use when encoding unicode or decoding bytes.
this defaults to ``"utf-8"``.
:param param:
optional name of variable/noun to reference when raising errors.
:returns: :class:`str` instance
t
deprecateds 1.6t removeds 1.7c C s t | | d d S( s' deprecated, use to_native_str() insteadR t hash( R6 ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt to_hash_str s s true t yes y on 1 enable enableds# false f no n off 0 disable disabledt nonet booleanc C s t | t rj | j j } | t k r1 t S| t k rA t S| t k rQ | St d | | f n- t | t
r} | S| d k r | St
| Sd S( s\
helper to convert value to boolean.
recognizes strings such as "true", "false"
s unrecognized %s value: %rN( Rz R( t lowerR t _true_setRi t
_false_setRe t _none_setR t boolRt ( R R R t clean( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt as_bool s ( t cryptc C s d S( N( Rt ( t secretR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s s *:!c C s t | t r@ | } y | j d } Wq@ t k
r< d SXn t | k r[ t d n t | t r| | j d } n t | | } | s | d t k r d S| S( Ns utf-8s null character in secretR i ( Rz R R t UnicodeDecodeErrorRt t _NULLR t _cryptt _invalid_prefixes( R R t origR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s
c C s t | t r! | j d } n t | k r< t d n t | t r] | j d } n t | | } | sv d S| j d } | d t k r d S| S( Ns utf-8s null character in secretR i ( Rz R% R R R R Rt R R ( R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR9 s s Wrapper around stdlib's crypt.
This is a wrapper around stdlib's :func:`!crypt.crypt`, which attempts
to provide uniform behavior across Python 2 and 3.
:arg secret:
password, as bytes or unicode (unicode will be encoded as ``utf-8``).
:arg hash:
hash or config string, as ascii bytes or unicode.
:returns:
resulting hash as ascii unicode; or ``None`` if the password
couldn't be hashed due to one of the issues:
* :func:`crypt()` not available on platform.
* Under Python 3, if *secret* is specified as bytes,
it must be use ``utf-8`` or it can't be passed
to :func:`crypt()`.
* Some OSes will return ``None`` if they don't recognize
the algorithm being used (though most will simply fall
back to des-crypt).
* Some OSes will return an error string if the input config
is recognized but malformed; current code converts these to ``None``
as well.
c C s t | | | k S( s check if :func:`crypt.crypt` supports specific hash
:arg secret: password to test
:arg hash: known hash of password to use as reference
:returns: True or False
( R9 ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR8 A s t win32( t clock( t timec C sB t j d | } | r> t d | j d j d D Sd S( s helper to parse version strings (\d+(?:\.\d+)+)c s s | ] } t | Vq d S( N( R ( Rw R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys Y s i t .N( t ret searchR t groupR Rt ( R t m( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt
parse_versionU s &i c C s d d l m } t | d rd t | d rd y | j } Wqd t k
r` | j d } qd Xn t d | t t d r t j n d t
t t j t j
t r t j d j d
n d f } t | | j d j d
S( s. generate prng seed value from system resourcesi( t sha512t getstatet getrandbitsi i s %s %s %s %.15f %.15f %st getpidi s latin-1i s utf-8i i N( t hashlibR t hasattrR
R R R# t osR Rt t idt objectR R t has_urandomt urandomR R R t hexdigest( R R t text( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt genseedq s
(c s) s
t S f d } t | S( s] return byte-string containing *count* number of randomly generated bytes, using specified rngc 3 sM j d > } d } x- | k rH | d @V| d L} | d 7} q Wd S( Ni i i i ( R ( R R ( R R; ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt helper s
( t _BEMPTYR ( R; R R ( ( R R; s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR< s c s d k r t d n t d k rB t d n d k rV S f d } t t r t | St | Sd S( s| return string containing *count* number of chars/bytes, whose elements are drawn from specified charset, using specified rngi s count must be >= 0s alphabet must not be emptyi c 3 sT j d } d } x1 | k rO | V| } | d 7} q Wd S( Ni i ( t randrange( R R ( t charsetR t lettersR; ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR s
N( R RZ Rz R% R$ R ( R; R R R ( ( R R R R; s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR= s
t4 2346789ABCDEFGHJKMNPQRTUVWXYZabcdefghjkmnpqrstuvwxyzs 2.0t replacements/ passlib.pwd.genword() / passlib.pwd.genphrase()i
c C s t t | | S( sw generate random password using given length & charset
:param size:
size of password.
:param charset:
optional string specified set of characters to draw from.
the default charset contains all normal alphanumeric characters,
except for the characters ``1IiLl0OoS5``, which were omitted
due to their visual similarity.
:returns: :class:`!str` containing randomly generated password.
.. note::
Using the default character set, on a OS with :class:`!SystemRandom` support,
this function should generate passwords with 5.7 bits of entropy per character.
( R= R; ( R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR> s R t setting_kwdst context_kwdst verifyR t identifyc s t f d t D S( s4 check if object follows the :ref:`password-hash-api`c 3 s | ] } t | Vq d S( N( R ( Rw R ( t obj( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( R t _handler_attrs( R" ( ( R" s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR? s t needs_updatet genconfigt genhasht encryptc s t f d t D S( sO check if object appears to be a :class:`~passlib.context.CryptContext` instancec 3 s | ] } t | Vq d S( N( R ( Rw R ( R" ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pys s ( R t _context_attrs( R" ( ( R" s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyR@ s c C s% d | j k o$ t | d d d k S( s_ check if handler provides the optional :ref:`rounds information ` attributest roundst
min_roundsN( R t getattrRt ( t handler( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRA s c C s% d | j k o$ t | d d d k S( s[ check if handler provides the optional :ref:`salt information ` attributest saltt
min_salt_sizeN( R R+ Rt ( R, ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyRB s t ( s names setting_kwdsR R s hashR! ( R$ R% R& R R' R! ( Ra t passlib.utils.compatR t binasciiR R R t _BinAsciiErrort base64R R R t codecsR R t functoolsR R Rb t loggingt getLoggerR_ t logt mathR t syst randomR R t ImportErrorRt R R R t typest warningsR t passlib.utils.binaryR R
R R R
R R R R R R R R t passlib.utils.decorR R R R R t passlib.excR R R R R R R! R" R# R$ R% R& R' R( R) R* t __all__R t maxsizet maxintR+ R, R- RL R R R t environRf t MAX_PASSWORD_SIZER RP t Parametert VAR_KEYWORDRk t sett VAR_POSITIONALRh Rp Re R R R. t str_consteqt hmacR R R/ R1 R R R R R0 R R R R R R R R R2 R R R3 R4 R5 R6 R R R R R R R R R7 R9 Ri R R R8 t platformR t timerR: R R R R R t SystemRandomR; t RandomR< R= t
_52charsetR> R# R? R( R@ RA RB ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/__init__.pyt sJ
X(d .
V >
%
!
Command.pyo 0000644 00000025602 14722167475 0006677 0 ustar 00
.t_c @ s d Z d d l m Z d d l m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d e
f d YZ d e f d YZ
d
Z d Z d S( s
Command - runs commands and manages their results
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Command.py#3 $
i ( t Loggeri( t Popent PIPENt CommandErrorc B sD e Z d Z d Z d Z d Z d Z d Z d Z RS( s Exception raised to indicate an error running a command.
Arguments:
exitCode (int): The exit code of the command
stdout (string): The output from the command
stderr (string): The error output from the command
message (string): The (localized) error text; will be formatted with
the remaining arguments
args: Arguments for formatting the message
c C s | j S( N( t _exitCode( t self( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt getExitCode0 s c C s | j S( N( t _stderr( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt getStandardError4 s c C s | | j | | j d S( s Log the outputs of the failed command which generated this exception.
Arguments:
logMethod (callable): The method to log with
N( t _stdoutR ( R t logMethod( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt
logOutputs8 s
c G s | j | | _ d S( s Set the error message in this exception.
Arguments:
message (string): The (localized) message text; will be formatted
with *args
args: Values to pass to the format of message
N( t formatt _message( R t messaget args( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt
setMessageB s c G sB t t | j | | _ | | _ | | _ | j | | d S( N( t superR t __init__R R R R ( R t exitCodet stdoutt stderrR R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyR O s
c C s | j S( N( R
( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt __str__W s ( t __name__t
__module__t __doc__R R R R R R ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyR " s
t Commandc B s e Z d Z e Z d Z e j e j d Z
e d Z e e e d Z
d Z d Z d
d Z d Z d d d d
Z d Z d Z RS( sV Command encapsulates shell commands, runs them, and manages the result.
Attributes:
noRun (bool): if True, don't run the command, and always succeed
shell (bool): if True, run this command using shell -c
verbose (int): if > 0, print commands to stdout before executing them
_commandList (list): command and its arguments
i s .Commandc C s | j S( s+ Returns True iff Commands default to noRun.( t defaultNoRun( t cls( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt noRunModek s c C s1 | r | | _ t | _ n | r- | | _ n d S( s Sets the verbose and noRun default values.
Arguments:
verbose: (boolean) If True, operate verbosely.
noRun: (boolean) If True, do not actually execute.
N( R t Truet defaultVerbose( R t verboset noRun( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt setDefaultsq s
c C s | j d S( s3 Returns an identifier (argv[0]) for error messages.i ( t _commandList( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt commandName s c K s | j d d } | j d d } | j sE | j d t | _ n | j } | d k ry | j j d j | n yxt | D]} | d k r | j j d j | | n | j d k r d | GH| j j
| n | j r d Sy3 | j | } | j d
t r | j
S| SWq t k
r} | | d k r~| d k ru| j t d | j | n | n t j d q Xq WWn/ t k
r} | j d t rd
S| n Xd S( s Run a command.
Returns the output of running the command.
Arguments:
noThrow: If True, will return an empty string instead of throwing on
error.
retries: The number of times to try the command before giving up.
Defaults to 1.
shell: Indicate that this is a shell command
stdin: If not None, the stream from which the command should take
its input, defaults to None.
strip: If True, strip leading and trailing whitespace from the
command output before returning it.
Exceptions:
CommandError: if the command failed and noThrow is False
t retriesi t stdint shells Waiting for '{0}'s
... {0}/{1}i s Nt strips {0}: timed out after {1} secondst noThrowt ( t gett NoneR' t Falset _getCommandLinet logt debugR t rangeR t infoR! t _executeR( R R t _R$ t timet sleep( R t kwargsR% R& t commandLinet countt outputt e( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt run s< $ c C s t t | j t j | _ t | _ t j | _ | | _ | r t
j t j
| _ x3 | j D] \ } } | | j | s 9 Logger.pyc 0000644 00000007252 14722167475 0006525 0 ustar 00
.t_c @ s` d Z d d l Z d d l Z d d l Z d d l Z d d l m Z d e f d YZ d S( si
Logger - VDO manager logging
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Logger.py#3 $
iN( t
MethodTypet Loggerc B s~ e Z d Z e j j e j d Z e Z
d Z e
d Z e
d e d Z e
d Z e
d Z d Z RS( s Wrappers and configuration methods for the Python logger.
Attributes:
logfile (string): the path to the logfile if specified.
myname (string): name of the command being run.
quiet (bool): if True, don't print to stdout.
i c C s" | j s | GHn | j | d S( s4 Print a status message to stdout and log it as well.N( t quiett info( t clst loggert msg( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt announce/ s c C s; | | _ | | _ | } d } | r* d n d | } t j } | j t j t j t j } | j t j
| j | | j | r t j n t j | j
| | j d k ry t j j | j rt j j | j rt | j d } t j d | } n! t j j | j d d d d
} t j
d | }
| j |
| j | ret j n t j | j
| Wqt k
r} | j d j d
| j d | qXn yS t j j d d } | j t j
| j | | j t j | j
| Wn) t k
r6} | j d j | n Xd S( s8 Configure the logging system according to the arguments.s : %(levelname)s - %(message)ss
: %(name)st t wt streamt maxBytesi
i t backupCounti s %(asctime)s %(name)ss. Unable to configure logging to {logfile}: {ex}t logfilet ext addresss /dev/logs, Unable to configure logging for rsyslog: {0}Ni ( i ( t mynameR
t loggingt getLoggert setLevelt NOTSETt
StreamHandlert syst stderrt setFormattert Formattert DEBUGt WARNINGt
addHandlert Nonet ost patht existst isfilet opent handlerst RotatingFileHandlert INFOt Exceptiont warnt formatt
SysLogHandler( R t nameR
t debugt debuggingt
formatBaset debugBaseR t handlert logstreamt formatterR ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt configure7 sB
+
c C s. t j | } t | j | | j | _ | S( s; Returns a Python logger decorated with the announce method.( R R R R t __class__( R R* R ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR b s c C s6 g } | j d k r2 | j d t | j n | S( sB Return a list of strings containing the logging options specified.s
--logfile=N( R
R t appendt str( R t options( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt loggingOptionsj s c C s t t | j d S( N( t superR t __init__( t self( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR9 u s N( t __name__t
__module__t __doc__R R t basenameR t argvR t FalseR R R
t classmethodR R2 R R7 R9 ( ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyR s * ( R= R t logging.handlersR R t typesR t objectR ( ( ( s4 /usr/lib/python2.7/site-packages/vdo/utils/Logger.pyt s YAMLObject.pyc 0000644 00000016340 14722167475 0007175 0 ustar 00
.t_c @ sH d Z d d l Z d d l Z e j d d e j f d YZ d S( s}
YAMLObject - Provides mapping to/from YAML.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/YAMLObject.py#2 $
iNt utilst
YAMLObjectc B s e Z d Z e j Z e d Z e d Z d Z e d Z
e d Z e d Z
d Z e d Z d Z RS(
s Provides conversion of objects to and from YAML representations.
The attributes that are included in the YAML representation are taken
from an instance's __dict__ filtered through the list returned from the
_yamlAttributeKeys property.
The list from the _yamlAttributeKeys property is used to check for missing
attributes when generating the YAML representation. It is also used
to check for missing or extraneous attributes when constructing an instance
from the YAML representation.
Subclasses must override _yamlAttributeKeys.
Subclasses must specify the class attribute yaml_tag which indicates the type
of the instance in the YAML representation.
Class attributes:
yaml_tag (unicode string) - YAML representation identfifier;
must be specified by subclasses
yaml_loader - The loader to use; set to yaml.SafeLoader
to allow yaml.load_safe() to instantiate
objects
c c s1 | j } | V| j | } | j | d S( s Constructs and returns an instance from its YAML representation.
Returns:
instance constructed from YAML representation.
N( t _yamlMakeInstancet construct_mappingt _yamlSetAttributes( t clst loadert nodet instancet mapping( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt from_yaml> s c C s | j } | j | j | S( sg Returns a YAML representation of the instance.
Returns:
YAML representation of instance
( t _yamlDatat represent_mappingt yaml_tag( R t dumpert datat yamlData( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt to_yamlK s c C s t t | j i | _ d S( N( t superR t __init__t _preservedExtraAttributes( t self( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR V s c C s | S( s Returns an instance of the class specifying placeholder values for
any arguments required by the __init__ method.
The default implementation is to instantiate without arguments.
Subclasses must override if their __init__ method takes arguments.
( ( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR ] s c C sf t g | j j D]6 \ } } | | j k r | | j k r | | f ^ q } | j | j | S( s
Returns a dictionary containing the data to include in generating
the instance's YAML representation.
The base implementation uses the contents of the instance's __dict__
filtered through the list of keys returned from _yamlAttributeKeys
excluding any that require special handling (subclasses must override this
method to add those) and adds any entries from the preserved extra
attributes.
Returns:
dictionary of data to use in generating the instance's YAML
representation
( t dictt __dict__t iteritemst _yamlAttributeKeyst _yamlSpeciallyHandledAttributest updateR ( R t keyt valueR ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR h s $c C s
t d S( s Returns a list of the keys for the attributes to include in the
instance's YAML representation.
Must be overridden by subclasses.
Returns:
list of keys for attributes to include in the instance's YAML
representation
N( t NotImplementedError( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s c C s t g | j D]' \ } } | | j k r | | f ^ q } | j j | g | j D]* } | | j k r] | | j k r] | ^ q] } x" | D] } t | | | | q Wd S( s Sets the instance's internal attributes from the YAML attributes.
By default, the attributes are set via invoking setattr() targeted
to the instance. If a subclass uses different internal names or
computes the attributes in some way it must override this method
to handle the attributes appropriately. The subclass must also account
for the possibility that the attributes it receives may not contain the
entirety of such specially handled attributes; in other words, it must
check for each attribute's existence in the attributes dictionary it
receives. Any unspecified attributes must be given a default value in
whatever manner the subclass chooses.
Any entries in the specified attributes which are unknown to the entity
being constructed are preserved for later use in generating YAML output.
Arguments:
attributes (dictionary) - the attributes from the YAML representation
N( R t itemsR R R t keysR t setattr( R t
attributesR R t extraR ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s $
c C s g S( s Returns a list of attributes that are specially handled by subclasses.
These attributes are skipped by _yamlData and _yamlSetAttributes
implemented by YAMLObject.
Subclasses must override both _yamlData and _yamlSetAttributes to handle
these attributes.
( ( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s c C sA t | t | s* t t d n | j j | j d S( s Updates the current object (self) from the specified instance.
This is for classes that perform indirect construction using the results
of the YAML load. Instances of such classes are required to invoke this
method themselves.
The specified instance must be the same class (or a subclass) of the
current object to guarantee that any attributes the current object attempts
to update will be available from the instance.
Arguments:
instance (YAMLObject) - object source for update
Raises:
TypeError - specified instance is not the same class (or a subclass)
of the current object
s( attempt to update from incompatible typeN( t
isinstancet typet TypeErrort _R R ( R R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt _yamlUpdateFromInstance s ( t __name__t
__module__t __doc__t yamlt
SafeLoadert yaml_loadert classmethodR
R R R t propertyR R R R R( ( ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR " s
( R+ t gettextR, t installR ( ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt s
YAMLObject.py 0000644 00000017275 14722167475 0007042 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
YAMLObject - Provides mapping to/from YAML.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/YAMLObject.py#2 $
"""
import gettext
import yaml
gettext.install("utils")
########################################################################
class YAMLObject(yaml.YAMLObject):
"""Provides conversion of objects to and from YAML representations.
The attributes that are included in the YAML representation are taken
from an instance's __dict__ filtered through the list returned from the
_yamlAttributeKeys property.
The list from the _yamlAttributeKeys property is used to check for missing
attributes when generating the YAML representation. It is also used
to check for missing or extraneous attributes when constructing an instance
from the YAML representation.
Subclasses must override _yamlAttributeKeys.
Subclasses must specify the class attribute yaml_tag which indicates the type
of the instance in the YAML representation.
Class attributes:
yaml_tag (unicode string) - YAML representation identfifier;
must be specified by subclasses
yaml_loader - The loader to use; set to yaml.SafeLoader
to allow yaml.load_safe() to instantiate
objects
"""
yaml_loader = yaml.SafeLoader
######################################################################
# Overridden methods
######################################################################
@classmethod
def from_yaml(cls, loader, node):
"""Constructs and returns an instance from its YAML representation.
Returns:
instance constructed from YAML representation.
"""
instance = cls._yamlMakeInstance()
yield instance
mapping = loader.construct_mapping(node)
instance._yamlSetAttributes(mapping)
######################################################################
@classmethod
def to_yaml(cls, dumper, data):
"""Returns a YAML representation of the instance.
Returns:
YAML representation of instance
"""
yamlData = data._yamlData
return dumper.represent_mapping(data.yaml_tag, yamlData)
######################################################################
def __init__(self):
super(YAMLObject, self).__init__()
self._preservedExtraAttributes = {}
######################################################################
# Protected methods
######################################################################
@classmethod
def _yamlMakeInstance(cls):
"""Returns an instance of the class specifying placeholder values for
any arguments required by the __init__ method.
The default implementation is to instantiate without arguments.
Subclasses must override if their __init__ method takes arguments.
"""
return cls()
######################################################################
@property
def _yamlData(self):
"""Returns a dictionary containing the data to include in generating
the instance's YAML representation.
The base implementation uses the contents of the instance's __dict__
filtered through the list of keys returned from _yamlAttributeKeys
excluding any that require special handling (subclasses must override this
method to add those) and adds any entries from the preserved extra
attributes.
Returns:
dictionary of data to use in generating the instance's YAML
representation
"""
data = dict([(key, value)
for key, value in self.__dict__.iteritems()
if ((key in self._yamlAttributeKeys)
and (key not in self._yamlSpeciallyHandledAttributes))])
data.update(self._preservedExtraAttributes)
return data
######################################################################
@property
def _yamlAttributeKeys(self):
"""Returns a list of the keys for the attributes to include in the
instance's YAML representation.
Must be overridden by subclasses.
Returns:
list of keys for attributes to include in the instance's YAML
representation
"""
raise NotImplementedError
######################################################################
def _yamlSetAttributes(self, attributes):
"""Sets the instance's internal attributes from the YAML attributes.
By default, the attributes are set via invoking setattr() targeted
to the instance. If a subclass uses different internal names or
computes the attributes in some way it must override this method
to handle the attributes appropriately. The subclass must also account
for the possibility that the attributes it receives may not contain the
entirety of such specially handled attributes; in other words, it must
check for each attribute's existence in the attributes dictionary it
receives. Any unspecified attributes must be given a default value in
whatever manner the subclass chooses.
Any entries in the specified attributes which are unknown to the entity
being constructed are preserved for later use in generating YAML output.
Arguments:
attributes (dictionary) - the attributes from the YAML representation
"""
extra = dict([(key, value)
for key, value in attributes.items()
if key not in self._yamlAttributeKeys])
self._preservedExtraAttributes.update(extra)
keys = [key for key in attributes.keys()
if (key in self._yamlAttributeKeys)
and (key not in self._yamlSpeciallyHandledAttributes)]
for key in keys:
setattr(self, key, attributes[key])
######################################################################
@property
def _yamlSpeciallyHandledAttributes(self):
"""Returns a list of attributes that are specially handled by subclasses.
These attributes are skipped by _yamlData and _yamlSetAttributes
implemented by YAMLObject.
Subclasses must override both _yamlData and _yamlSetAttributes to handle
these attributes.
"""
return []
######################################################################
def _yamlUpdateFromInstance(self, instance):
"""Updates the current object (self) from the specified instance.
This is for classes that perform indirect construction using the results
of the YAML load. Instances of such classes are required to invoke this
method themselves.
The specified instance must be the same class (or a subclass) of the
current object to guarantee that any attributes the current object attempts
to update will be available from the instance.
Arguments:
instance (YAMLObject) - object source for update
Raises:
TypeError - specified instance is not the same class (or a subclass)
of the current object
"""
if (not isinstance(instance, type(self))):
raise TypeError(_("attempt to update from incompatible type"))
self._preservedExtraAttributes.update(instance._preservedExtraAttributes)
Timeout.py 0000644 00000006151 14722167475 0006566 0 ustar 00 #
# Copyright (c) 2018 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
"""
Timeout - context manager that implements a timeout.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Timeout.py#1 $
"""
import signal
########################################################################
class TimeoutError(Exception):
"""Exception raised when a block times out."""
def __init__(self, msg = None, *args, **kwargs):
super(TimeoutError, self).__init__(*args, **kwargs)
if msg is None:
msg = "timeout"
self._msg = msg
def __str__(self):
return self._msg
########################################################################
class Timeout(object):
"""Context manager for running a block of commands under a timeout.
If the block times out, a TimeoutError is raised.
Arguments:
seconds (int) - timeout in seconds
msg (str) - message to supply to TimeoutError
"""
######################################################################
# Public methods
######################################################################
######################################################################
# Overridden methods
######################################################################
def __enter__(self):
# Establish the alarm handler and set the alarm to go off.
self.__oldHandler = signal.signal(signal.SIGALRM,
lambda _signum, _frame : self._timeout())
signal.alarm(self.__seconds)
return self
######################################################################
def __exit__(self, exceptionType, exceptionValue, traceback):
# Turn off the alarm and re-establish the previous alarm handler.
signal.alarm(0)
signal.signal(signal.SIGALRM, self.__oldHandler)
# Don't suppress exceptions.
return False
######################################################################
def __init__(self, seconds, msg = None):
self.__seconds = seconds
self.__msg = msg
self.__oldHandler = None
######################################################################
# Protected methods
######################################################################
def _timeout(self):
""" Method invoked if the alarm goes off.
"""
raise TimeoutError(self.__msg)
######################################################################
# Private methods
######################################################################
YAMLObject.pyo 0000644 00000016340 14722167475 0007211 0 ustar 00
.t_c @ sH d Z d d l Z d d l Z e j d d e j f d YZ d S( s}
YAMLObject - Provides mapping to/from YAML.
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/YAMLObject.py#2 $
iNt utilst
YAMLObjectc B s e Z d Z e j Z e d Z e d Z d Z e d Z
e d Z e d Z
d Z e d Z d Z RS(
s Provides conversion of objects to and from YAML representations.
The attributes that are included in the YAML representation are taken
from an instance's __dict__ filtered through the list returned from the
_yamlAttributeKeys property.
The list from the _yamlAttributeKeys property is used to check for missing
attributes when generating the YAML representation. It is also used
to check for missing or extraneous attributes when constructing an instance
from the YAML representation.
Subclasses must override _yamlAttributeKeys.
Subclasses must specify the class attribute yaml_tag which indicates the type
of the instance in the YAML representation.
Class attributes:
yaml_tag (unicode string) - YAML representation identfifier;
must be specified by subclasses
yaml_loader - The loader to use; set to yaml.SafeLoader
to allow yaml.load_safe() to instantiate
objects
c c s1 | j } | V| j | } | j | d S( s Constructs and returns an instance from its YAML representation.
Returns:
instance constructed from YAML representation.
N( t _yamlMakeInstancet construct_mappingt _yamlSetAttributes( t clst loadert nodet instancet mapping( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt from_yaml> s c C s | j } | j | j | S( sg Returns a YAML representation of the instance.
Returns:
YAML representation of instance
( t _yamlDatat represent_mappingt yaml_tag( R t dumpert datat yamlData( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt to_yamlK s c C s t t | j i | _ d S( N( t superR t __init__t _preservedExtraAttributes( t self( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR V s c C s | S( s Returns an instance of the class specifying placeholder values for
any arguments required by the __init__ method.
The default implementation is to instantiate without arguments.
Subclasses must override if their __init__ method takes arguments.
( ( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR ] s c C sf t g | j j D]6 \ } } | | j k r | | j k r | | f ^ q } | j | j | S( s
Returns a dictionary containing the data to include in generating
the instance's YAML representation.
The base implementation uses the contents of the instance's __dict__
filtered through the list of keys returned from _yamlAttributeKeys
excluding any that require special handling (subclasses must override this
method to add those) and adds any entries from the preserved extra
attributes.
Returns:
dictionary of data to use in generating the instance's YAML
representation
( t dictt __dict__t iteritemst _yamlAttributeKeyst _yamlSpeciallyHandledAttributest updateR ( R t keyt valueR ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR h s $c C s
t d S( s Returns a list of the keys for the attributes to include in the
instance's YAML representation.
Must be overridden by subclasses.
Returns:
list of keys for attributes to include in the instance's YAML
representation
N( t NotImplementedError( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s c C s t g | j D]' \ } } | | j k r | | f ^ q } | j j | g | j D]* } | | j k r] | | j k r] | ^ q] } x" | D] } t | | | | q Wd S( s Sets the instance's internal attributes from the YAML attributes.
By default, the attributes are set via invoking setattr() targeted
to the instance. If a subclass uses different internal names or
computes the attributes in some way it must override this method
to handle the attributes appropriately. The subclass must also account
for the possibility that the attributes it receives may not contain the
entirety of such specially handled attributes; in other words, it must
check for each attribute's existence in the attributes dictionary it
receives. Any unspecified attributes must be given a default value in
whatever manner the subclass chooses.
Any entries in the specified attributes which are unknown to the entity
being constructed are preserved for later use in generating YAML output.
Arguments:
attributes (dictionary) - the attributes from the YAML representation
N( R t itemsR R R t keysR t setattr( R t
attributesR R t extraR ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s $
c C s g S( s Returns a list of attributes that are specially handled by subclasses.
These attributes are skipped by _yamlData and _yamlSetAttributes
implemented by YAMLObject.
Subclasses must override both _yamlData and _yamlSetAttributes to handle
these attributes.
( ( R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR s c C sA t | t | s* t t d n | j j | j d S( s Updates the current object (self) from the specified instance.
This is for classes that perform indirect construction using the results
of the YAML load. Instances of such classes are required to invoke this
method themselves.
The specified instance must be the same class (or a subclass) of the
current object to guarantee that any attributes the current object attempts
to update will be available from the instance.
Arguments:
instance (YAMLObject) - object source for update
Raises:
TypeError - specified instance is not the same class (or a subclass)
of the current object
s( attempt to update from incompatible typeN( t
isinstancet typet TypeErrort _R R ( R R ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt _yamlUpdateFromInstance s ( t __name__t
__module__t __doc__t yamlt
SafeLoadert yaml_loadert classmethodR
R R R t propertyR R R R R( ( ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyR " s
( R+ t gettextR, t installR ( ( ( s8 /usr/lib/python2.7/site-packages/vdo/utils/YAMLObject.pyt s
Command.pyc 0000644 00000025602 14722167475 0006663 0 ustar 00
.t_c @ s d Z d d l m Z d d l m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d e
f d YZ d e f d YZ
d
Z d Z d S( s
Command - runs commands and manages their results
$Id: //eng/vdo-releases/magnesium/src/python/vdo/utils/Command.py#3 $
i ( t Loggeri( t Popent PIPENt CommandErrorc B sD e Z d Z d Z d Z d Z d Z d Z d Z RS( s Exception raised to indicate an error running a command.
Arguments:
exitCode (int): The exit code of the command
stdout (string): The output from the command
stderr (string): The error output from the command
message (string): The (localized) error text; will be formatted with
the remaining arguments
args: Arguments for formatting the message
c C s | j S( N( t _exitCode( t self( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt getExitCode0 s c C s | j S( N( t _stderr( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt getStandardError4 s c C s | | j | | j d S( s Log the outputs of the failed command which generated this exception.
Arguments:
logMethod (callable): The method to log with
N( t _stdoutR ( R t logMethod( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt
logOutputs8 s
c G s | j | | _ d S( s Set the error message in this exception.
Arguments:
message (string): The (localized) message text; will be formatted
with *args
args: Values to pass to the format of message
N( t formatt _message( R t messaget args( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt
setMessageB s c G sB t t | j | | _ | | _ | | _ | j | | d S( N( t superR t __init__R R R R ( R t exitCodet stdoutt stderrR R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyR O s
c C s | j S( N( R
( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt __str__W s ( t __name__t
__module__t __doc__R R R R R R ( ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyR " s
t Commandc B s e Z d Z e Z d Z e j e j d Z
e d Z e e e d Z
d Z d Z d
d Z d Z d d d d
Z d Z d Z RS( sV Command encapsulates shell commands, runs them, and manages the result.
Attributes:
noRun (bool): if True, don't run the command, and always succeed
shell (bool): if True, run this command using shell -c
verbose (int): if > 0, print commands to stdout before executing them
_commandList (list): command and its arguments
i s .Commandc C s | j S( s+ Returns True iff Commands default to noRun.( t defaultNoRun( t cls( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt noRunModek s c C s1 | r | | _ t | _ n | r- | | _ n d S( s Sets the verbose and noRun default values.
Arguments:
verbose: (boolean) If True, operate verbosely.
noRun: (boolean) If True, do not actually execute.
N( R t Truet defaultVerbose( R t verboset noRun( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt setDefaultsq s
c C s | j d S( s3 Returns an identifier (argv[0]) for error messages.i ( t _commandList( R ( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt commandName s c K s | j d d } | j d d } | j sE | j d t | _ n | j } | d k ry | j j d j | n yxt | D]} | d k r | j j d j | | n | j d k r d | GH| j j
| n | j r d Sy3 | j | } | j d
t r | j
S| SWq t k
r} | | d k r~| d k ru| j t d | j | n | n t j d q Xq WWn/ t k
r} | j d t rd
S| n Xd S( s Run a command.
Returns the output of running the command.
Arguments:
noThrow: If True, will return an empty string instead of throwing on
error.
retries: The number of times to try the command before giving up.
Defaults to 1.
shell: Indicate that this is a shell command
stdin: If not None, the stream from which the command should take
its input, defaults to None.
strip: If True, strip leading and trailing whitespace from the
command output before returning it.
Exceptions:
CommandError: if the command failed and noThrow is False
t retriesi t stdint shells Waiting for '{0}'s
... {0}/{1}i s Nt strips {0}: timed out after {1} secondst noThrowt ( t gett NoneR' t Falset _getCommandLinet logt debugR t rangeR t infoR! t _executeR( R R t _R$ t timet sleep( R t kwargsR% R& t commandLinet countt outputt e( ( s5 /usr/lib/python2.7/site-packages/vdo/utils/Command.pyt run s< $ c C s t t | j t j | _ t | _ t j | _ | | _ | r t
j t j
| _ x3 | j D] \ } } | | j | s 9 pbkdf2.py 0000644 00000015260 14722170205 0006272 0 ustar 00 """passlib.pbkdf2 - PBKDF2 support
this module is getting increasingly poorly named.
maybe rename to "kdf" since it's getting more key derivation functions added.
"""
#=============================================================================
# imports
#=============================================================================
from __future__ import division
# core
import logging; log = logging.getLogger(__name__)
# site
# pkg
from passlib.exc import ExpectedTypeError
from passlib.utils.decor import deprecated_function
from passlib.utils.compat import native_string_types
from passlib.crypto.digest import norm_hash_name, lookup_hash, pbkdf1 as _pbkdf1, pbkdf2_hmac, compile_hmac
# local
__all__ = [
# hash utils
"norm_hash_name",
# prf utils
"get_prf",
# kdfs
"pbkdf1",
"pbkdf2",
]
#=============================================================================
# issue deprecation warning for module
#=============================================================================
from warnings import warn
warn("the module 'passlib.utils.pbkdf2' is deprecated as of Passlib 1.7, "
"and will be removed in Passlib 2.0, please use 'passlib.crypto' instead",
DeprecationWarning)
#=============================================================================
# hash helpers
#=============================================================================
norm_hash_name = deprecated_function(deprecated="1.7", removed="1.8", func_module=__name__,
replacement="passlib.crypto.digest.norm_hash_name")(norm_hash_name)
#=============================================================================
# prf lookup
#=============================================================================
#: cache mapping prf name/func -> (func, digest_size)
_prf_cache = {}
#: list of accepted prefixes
_HMAC_PREFIXES = ("hmac_", "hmac-")
def get_prf(name):
"""Lookup pseudo-random family (PRF) by name.
:arg name:
This must be the name of a recognized prf.
Currently this only recognizes names with the format
:samp:`hmac-{digest}`, where :samp:`{digest}`
is the name of a hash function such as
``md5``, ``sha256``, etc.
todo: restore text about callables.
:raises ValueError: if the name is not known
:raises TypeError: if the name is not a callable or string
:returns:
a tuple of :samp:`({prf_func}, {digest_size})`, where:
* :samp:`{prf_func}` is a function implementing
the specified PRF, and has the signature
``prf_func(secret, message) -> digest``.
* :samp:`{digest_size}` is an integer indicating
the number of bytes the function returns.
Usage example::
>>> from passlib.utils.pbkdf2 import get_prf
>>> hmac_sha256, dsize = get_prf("hmac-sha256")
>>> hmac_sha256
>>> dsize
32
>>> digest = hmac_sha256('password', 'message')
.. deprecated:: 1.7
This function is deprecated, and will be removed in Passlib 2.0.
This only related replacement is :func:`passlib.crypto.digest.compile_hmac`.
"""
global _prf_cache
if name in _prf_cache:
return _prf_cache[name]
if isinstance(name, native_string_types):
if not name.startswith(_HMAC_PREFIXES):
raise ValueError("unknown prf algorithm: %r" % (name,))
digest = lookup_hash(name[5:]).name
def hmac(key, msg):
return compile_hmac(digest, key)(msg)
record = (hmac, hmac.digest_info.digest_size)
elif callable(name):
# assume it's a callable, use it directly
digest_size = len(name(b'x', b'y'))
record = (name, digest_size)
else:
raise ExpectedTypeError(name, "str or callable", "prf name")
_prf_cache[name] = record
return record
#=============================================================================
# pbkdf1 support
#=============================================================================
def pbkdf1(secret, salt, rounds, keylen=None, hash="sha1"):
"""pkcs#5 password-based key derivation v1.5
:arg secret: passphrase to use to generate key
:arg salt: salt string to use when generating key
:param rounds: number of rounds to use to generate key
:arg keylen: number of bytes to generate (if ``None``, uses digest's native size)
:param hash:
hash function to use. must be name of a hash recognized by hashlib.
:returns:
raw bytes of generated key
.. note::
This algorithm has been deprecated, new code should use PBKDF2.
Among other limitations, ``keylen`` cannot be larger
than the digest size of the specified hash.
.. deprecated:: 1.7
This has been relocated to :func:`passlib.crypto.digest.pbkdf1`,
and this version will be removed in Passlib 2.0.
*Note the call signature has changed.*
"""
return _pbkdf1(hash, secret, salt, rounds, keylen)
#=============================================================================
# pbkdf2
#=============================================================================
def pbkdf2(secret, salt, rounds, keylen=None, prf="hmac-sha1"):
"""pkcs#5 password-based key derivation v2.0
:arg secret:
passphrase to use to generate key
:arg salt:
salt string to use when generating key
:param rounds:
number of rounds to use to generate key
:arg keylen:
number of bytes to generate.
if set to ``None``, will use digest size of selected prf.
:param prf:
psuedo-random family to use for key strengthening.
this must be a string starting with ``"hmac-"``, followed by the name of a known digest.
this defaults to ``"hmac-sha1"`` (the only prf explicitly listed in
the PBKDF2 specification)
.. rst-class:: warning
.. versionchanged 1.7:
This argument no longer supports arbitrary PRF callables --
These were rarely / never used, and created too many unwanted codepaths.
:returns:
raw bytes of generated key
.. deprecated:: 1.7
This has been deprecated in favor of :func:`passlib.crypto.digest.pbkdf2_hmac`,
and will be removed in Passlib 2.0. *Note the call signature has changed.*
"""
if callable(prf) or (isinstance(prf, native_string_types) and not prf.startswith(_HMAC_PREFIXES)):
raise NotImplementedError("non-HMAC prfs are not supported as of Passlib 1.7")
digest = prf[5:]
return pbkdf2_hmac(digest, secret, salt, rounds, keylen)
#=============================================================================
# eof
#=============================================================================
pbkdf2.pyo 0000644 00000013743 14722170205 0006455 0 ustar 00
5Xc @ s d Z d d l m Z d d l Z e j e Z d d l m Z d d l m
Z
d d l m Z d d l
m Z m Z m Z m Z m Z d d d
d g Z d d l m Z e d
e e
d d d d d e d d e Z i a d Z d Z d d d Z d d d Z d S( s passlib.pbkdf2 - PBKDF2 support
this module is getting increasingly poorly named.
maybe rename to "kdf" since it's getting more key derivation functions added.
i( t divisionN( t ExpectedTypeError( t deprecated_function( t native_string_types( t norm_hash_namet lookup_hasht pbkdf1t pbkdf2_hmact compile_hmacR t get_prfR t pbkdf2( t warns the module 'passlib.utils.pbkdf2' is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0, please use 'passlib.crypto' insteadt
deprecateds 1.7t removeds 1.8t func_modulet replacements$ passlib.crypto.digest.norm_hash_namet hmac_s hmac-c s | t k r t | St | t r | j t sH t d | f n t | d j f d } | | j j f } nB t
| r t | d d } | | f } n t | d d | t | <| S( s Lookup pseudo-random family (PRF) by name.
:arg name:
This must be the name of a recognized prf.
Currently this only recognizes names with the format
:samp:`hmac-{digest}`, where :samp:`{digest}`
is the name of a hash function such as
``md5``, ``sha256``, etc.
todo: restore text about callables.
:raises ValueError: if the name is not known
:raises TypeError: if the name is not a callable or string
:returns:
a tuple of :samp:`({prf_func}, {digest_size})`, where:
* :samp:`{prf_func}` is a function implementing
the specified PRF, and has the signature
``prf_func(secret, message) -> digest``.
* :samp:`{digest_size}` is an integer indicating
the number of bytes the function returns.
Usage example::
>>> from passlib.utils.pbkdf2 import get_prf
>>> hmac_sha256, dsize = get_prf("hmac-sha256")
>>> hmac_sha256
>>> dsize
32
>>> digest = hmac_sha256('password', 'message')
.. deprecated:: 1.7
This function is deprecated, and will be removed in Passlib 2.0.
This only related replacement is :func:`passlib.crypto.digest.compile_hmac`.
s unknown prf algorithm: %ri c s t | | S( N( R ( t keyt msg( t digest( s8 /usr/lib/python2.7/site-packages/passlib/utils/pbkdf2.pyt hmach s t xt ys str or callables prf name(
t
_prf_cachet
isinstanceR t
startswitht _HMAC_PREFIXESt
ValueErrorR t namet digest_infot digest_sizet callablet lenR ( R R t recordR ( ( R s8 /usr/lib/python2.7/site-packages/passlib/utils/pbkdf2.pyR 9 s )
t sha1c C s t | | | | | S( sL pkcs#5 password-based key derivation v1.5
:arg secret: passphrase to use to generate key
:arg salt: salt string to use when generating key
:param rounds: number of rounds to use to generate key
:arg keylen: number of bytes to generate (if ``None``, uses digest's native size)
:param hash:
hash function to use. must be name of a hash recognized by hashlib.
:returns:
raw bytes of generated key
.. note::
This algorithm has been deprecated, new code should use PBKDF2.
Among other limitations, ``keylen`` cannot be larger
than the digest size of the specified hash.
.. deprecated:: 1.7
This has been relocated to :func:`passlib.crypto.digest.pbkdf1`,
and this version will be removed in Passlib 2.0.
*Note the call signature has changed.*
( t _pbkdf1( t secrett saltt roundst keylent hash( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/pbkdf2.pyR w s s hmac-sha1c C sZ t | s+ t | t r: | j t r: t d n | d } t | | | | | S( sW pkcs#5 password-based key derivation v2.0
:arg secret:
passphrase to use to generate key
:arg salt:
salt string to use when generating key
:param rounds:
number of rounds to use to generate key
:arg keylen:
number of bytes to generate.
if set to ``None``, will use digest size of selected prf.
:param prf:
psuedo-random family to use for key strengthening.
this must be a string starting with ``"hmac-"``, followed by the name of a known digest.
this defaults to ``"hmac-sha1"`` (the only prf explicitly listed in
the PBKDF2 specification)
.. rst-class:: warning
.. versionchanged 1.7:
This argument no longer supports arbitrary PRF callables --
These were rarely / never used, and created too many unwanted codepaths.
:returns:
raw bytes of generated key
.. deprecated:: 1.7
This has been deprecated in favor of :func:`passlib.crypto.digest.pbkdf2_hmac`,
and will be removed in Passlib 2.0. *Note the call signature has changed.*
s1 non-HMAC prfs are not supported as of Passlib 1.7i ( R R R R R t NotImplementedErrorR ( R$ R% R& R' t prfR ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/pbkdf2.pyR
s %+
( R s hmac-( t __doc__t
__future__R t loggingt getLoggert __name__t logt passlib.excR t passlib.utils.decorR t passlib.utils.compatR t passlib.crypto.digestR R R R# R R t __all__t warningsR t DeprecationWarningR R R t NoneR
( ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/pbkdf2.pyt s* ( > des.py 0000644 00000004163 14722170205 0005675 0 ustar 00 """
passlib.utils.des - DEPRECATED LOCATION, WILL BE REMOVED IN 2.0
This has been moved to :mod:`passlib.crypto.des`.
"""
#=============================================================================
# import from new location
#=============================================================================
from warnings import warn
warn("the 'passlib.utils.des' module has been relocated to 'passlib.crypto.des' "
"as of passlib 1.7, and the old location will be removed in passlib 2.0",
DeprecationWarning)
#=============================================================================
# relocated functions
#=============================================================================
from passlib.utils.decor import deprecated_function
from passlib.crypto.des import expand_des_key, des_encrypt_block, des_encrypt_int_block
expand_des_key = deprecated_function(deprecated="1.7", removed="1.8",
replacement="passlib.crypto.des.expand_des_key")(expand_des_key)
des_encrypt_block = deprecated_function(deprecated="1.7", removed="1.8",
replacement="passlib.crypto.des.des_encrypt_block")(des_encrypt_block)
des_encrypt_int_block = deprecated_function(deprecated="1.7", removed="1.8",
replacement="passlib.crypto.des.des_encrypt_int_block")(des_encrypt_int_block)
#=============================================================================
# deprecated functions -- not carried over to passlib.crypto.des
#=============================================================================
import struct
_unpack_uint64 = struct.Struct(">Q").unpack
@deprecated_function(deprecated="1.6", removed="1.8",
replacement="passlib.crypto.des.des_encrypt_int_block()")
def mdes_encrypt_int_block(key, input, salt=0, rounds=1): # pragma: no cover -- deprecated & unused
if isinstance(key, bytes):
if len(key) == 7:
key = expand_des_key(key)
key = _unpack_uint64(key)[0]
return des_encrypt_int_block(key, input, salt, rounds)
#=============================================================================
# eof
#=============================================================================
decor.pyo 0000644 00000017703 14722170205 0006401 0 ustar 00
Xc @` s d Z d d l m Z m Z m Z d d l Z e j e Z d d l m
Z
m Z d d l Z d d l
m Z d d l m Z d d d d
d d g Z d e f d
YZ d e f d YZ d Z d
e f d YZ d d d e d e d d Z d d d e d d Z d S( s7
passlib.utils.decor -- helper decorators & properties
i ( t absolute_importt divisiont print_functionN( t wrapst update_wrapper( t warn( t PY3t
classpropertyt
hybrid_methodt memoize_single_valuet memoized_propertyt deprecated_functiont deprecated_methodc B` s/ e Z d Z d Z d Z e d Z RS( sj Function decorator which acts like a combination of classmethod+property (limited to read-only properties)c C` s
| | _ d S( N( t im_func( t selft func( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt __init__# s c C` s
| j | S( N( R
( R t objt cls( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt __get__& s c C` s | j S( s py3 compatible alias( R
( R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt __func__) s ( t __name__t
__module__t __doc__R R t propertyR ( ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR s c B` s e Z d Z d Z d Z RS( s
decorator which invokes function with class if called as class method,
and with object if called at instance level.
c C` s | | _ t | | d S( N( R R ( R R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR 4 s c C` sH | d k r | } n t r. t j | j | St j | j | | Sd S( N( t NoneR t typest
MethodTypeR ( R R R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR 8 s
( R R R R R ( ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR . s c ` s@ i t f d } f d } | | _ | S( s
decorator for function which takes no args,
and memoizes result. exposes a ``.clear_cache`` method
to clear the cached value.
c ` s5 y t SWn t k
r n X } t <| S( N( t Truet KeyError( t value( t cacheR ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt wrapperL s
c ` s j t d d S( N( t popR R ( ( R ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt clear_cacheU s ( R R" ( R R R" ( ( R R s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR D s
c B` sM e Z d Z d Z d Z e s6 e d Z n d Z d d Z
RS( sM
decorator which invokes method once, then replaces attr with result
c C` s% | | _ | j | _ | j | _ d S( N( R R R ( R R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR _ s c C` s6 | d k r | S| j | } t | | j | | S( N( R R t setattrR ( R R R R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR d s
c C` s | j S( s py2 alias( R ( R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR
m s c C` s | j j | j d d S( s
class-level helper to clear stored value (if any).
usage: :samp:`type(self).{attr}.clear_cache(self)`
N( t __dict__R! R R ( R R ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR" r s c C` s | j j | j | S( s
class-level helper to peek at stored value
usage: :samp:`value = type(self).{attr}.clear_cache(self)`
( R$ t getR ( R R t default( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt
peek_cachez s N( R R R R R R R R
R" R R' ( ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR
[ s c ` s d k rk r d n d r4 d 7 n rG d 7 n r^ d 7 n d 7 n f d } | S( sb decorator to deprecate a function.
:arg msg: optional msg, default chosen if omitted
:kwd deprecated: version when function was first deprecated
:kwd removed: version when function will be removed
:kwd replacement: alternate name / instructions for replacing this function.
:kwd updoc: add notice to docstring (default ``True``)
s5 the method %(mod)s.%(klass)s.%(name)s() is deprecateds- the function %(mod)s.%(name)s() is deprecateds as of Passlib %(deprecated)ss, , and will be removed in Passlib %(removed)ss , use %s insteadt .c ` s o t t r3 j d t j n t d pE j d j d d r f d } n f d } t |
r s r| j
rd | j
k r p d } s rG| d 7} r| d
f 7} n r: r)| d 7} n | d 7} n | d
7} n | j
j d j d st| j
d 7_
n | j
d | f 7_
n rt | } n | S( Nt modt namet
deprecatedt removedc ` si j } r | d n
| d j } | j d | j d | j t | t d d | | S( Ni t klassR) t
stackleveli ( t copyt __class__t updateR R R t DeprecationWarning( t argst kwdst tmpR- ( R t is_classmethodt msgt opts( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR s
c ` s t t d d | | S( NR. i ( R R2 ( R3 R4 ( R t text( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR s s .. deprecated::t s
s! and will be removed in version %ss , s use %s insteadR( t s
s
.. deprecated:: %s
(
t
isinstancet classmethodR R t typeR t dictR R R R t stript endswith( R R t txt( t
_is_methodR+ t func_moduleR7 R, t replacementt updoc( R R6 R8 R9 s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt build s>
N( R ( R7 R+ R, RF RE RC RD RG ( ( RC R+ RD R7 R, RE RF s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR s
!*c C` s t | | | | | d t S( sZ decorator to deprecate a method.
:arg msg: optional msg, default chosen if omitted
:kwd deprecated: version when method was first deprecated
:kwd removed: version when method will be removed
:kwd replacement: alternate name / instructions for replacing this method.
:kwd updoc: add notice to docstring (default ``True``)
RC ( R R ( R7 R+ R, RF RE ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyR s
( R t
__future__R R R t loggingt getLoggerR t logt functoolsR R R t warningsR t passlib.utils.compatR t __all__t objectR R R R
R R t FalseR R ( ( ( s7 /usr/lib/python2.7/site-packages/passlib/utils/decor.pyt s, < A binary.pyo 0000644 00000057410 14722170205 0006570 0 ustar 00
5Xc @` s d Z d d l m Z m Z m Z d d l m Z m Z m Z m
Z d d l m
Z
m Z m Z d d l Z e j e Z d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z m Z m! Z! m" Z" m# Z# d d l$ m% Z% d d
d d d
d d d d d d d d d d d d d d d d g Z& e! d Z' e! d Z( e! d Z) e! d! Z* e' e! d" Z+ e! d# Z, e! d$ Z- e! d% Z. e e d& Z/ d' Z0 d( Z1 d" Z2 e3 e e/ Z4 e5 d) Z6 d* Z7 d+ Z8 d, Z9 d" Z: d- Z; d. Z< d/ Z= d0 Z
e6 i d1 d2 6d3 d4 6 Z> e2 d5 Z? d6 Z d e@ f d7 YZA d eA f d8 YZB eB e) ZC eB e) d9 eD ZE eB e* d9 eD ZF d S(: sC
passlib.utils.binary - binary data encoding/decoding/manipulation
i ( t absolute_importt divisiont print_function( t b64encodet b64decodet b32decodet b32encode( t
b2a_base64t
a2b_base64t ErrorN( t exc( t PY3t
bascii_to_strt iranget imapt iter_byte_charst join_byte_valuest join_byte_elemst
nextgettert suppress_causet ut unicodet unicode_or_bytes_types( t memoized_propertyt BASE64_CHARSt PADDED_BASE64_CHARSt
AB64_CHARSt HASH64_CHARSt BCRYPT_CHARSt HEX_CHARSt LOWER_HEX_CHARSt UPPER_HEX_CHARSt ALL_BYTE_VALUESt compile_byte_translationt ab64_encodet ab64_decodet b64s_encodet b64s_decodeR R t Base64Enginet LazyBase64Enginet h64t h64bigt bcrypt64s@ ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/s@ ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789./s@ ./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzs@ ./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789t =t 0123456789abcdefABCDEFt 0123456789ABCDEFt 0123456789abcdefi t t c C` s | d k r t } n t t | } xc | j D]U \ } } t | t r_ t | } n t | t r | j d } n | | | output byte (str or int).
:param source:
optional existing byte translation string to use as base.
(must be 255-length byte string). defaults to identity mapping.
:returns:
255-length byte string for passing to bytes().translate.
t asciiN( t Nonet _TRANSLATE_SOURCEt listR t itemst
isinstanceR t ordR t encodet B_EMPTYt join( t mappingt sourcet targett kt v( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR! n s
c C` s t | j t S( sr
encode using shortened base64 format which omits padding & whitespace.
uses default ``+/`` altchars.
( R t rstript
_BASE64_STRIP( t data( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR$ s c C` s t | t rK y | j d } WqK t k
rG t t d qK Xn t | d @} | d k rj n> | d k r | t 7} n% | d k r | t 7} n t d y t | SWn% t
k
r } t t | n Xd S( sq
decode from shortened base64 format which omits padding & whitespace.
uses default ``+/`` altchars.
R1 s4 string argument should contain only ASCII charactersi i i s invalid base64 inputN( R6 R R8 t UnicodeEncodeErrorR t
ValueErrort lent _BASE64_PAD2t _BASE64_PAD1R t _BinAsciiErrort TypeError( RB t offt err( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR% s"
s =
s ==c C` s t | j d d S( s
encode using shortened base64 format which omits padding & whitespace.
uses custom ``./`` altchars.
it is primarily used by Passlib's custom pbkdf2 hashes.
t +t .( R$ t replace( RB ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR" s c C` sa t | t rK y | j d } WqK t k
rG t t d qK Xn t | j d d S( s
decode from shortened base64 format which omits padding & whitespace.
uses custom ``./`` altchars, but supports decoding normal ``+/`` altchars as well.
it is primarily used by Passlib's custom pbkdf2 hashes.
R1 s4 string argument should contain only ASCII charactersRM RL ( R6 R R8 RC R RD R% RN ( RB ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR# s
c C` s t t | j t S( sh
wrapper around :func:`base64.b32encode` which strips padding,
and returns a native string.
( R t
_b32encodeR@ t B_EQUAL( R< ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR s t Bt 8t Ot 0i c C` se t | t r! | j d } n | j t } t | d @} | rX | t | 7} n t | t S( s
wrapper around :func:`base64.b32decode`
which handles common mistyped chars.
padding optional, ignored if present.
R1 i ( R6 R R8 t translatet _b32_translateRE t _b32_decode_padt
_b32decodet True( R< t remainder( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR s c B` s: e Z d Z d Z d Z d Z d Z d Z d Z e
d Z e d Z
d Z d Z d Z d Z d Z d Z d Z e d
Z e d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d Z# d Z$ d Z% d Z& d Z' RS( sc Provides routines for encoding/decoding base64 data using
arbitrary character mappings, selectable endianness, etc.
:arg charmap:
A string of 64 unique characters,
which will be used to encode successive 6-bit chunks of data.
A character's position within the string should correspond
to its 6-bit value.
:param big:
Whether the encoding should be big-endian (default False).
.. note::
This class does not currently handle base64's padding characters
in any way what so ever.
Raw Bytes <-> Encoded Bytes
===========================
The following methods convert between raw bytes,
and strings encoded using the engine's specific base64 variant:
.. automethod:: encode_bytes
.. automethod:: decode_bytes
.. automethod:: encode_transposed_bytes
.. automethod:: decode_transposed_bytes
..
.. automethod:: check_repair_unused
.. automethod:: repair_unused
Integers <-> Encoded Bytes
==========================
The following methods allow encoding and decoding
unsigned integers to and from the engine's specific base64 variant.
Endianess is determined by the engine's ``big`` constructor keyword.
.. automethod:: encode_int6
.. automethod:: decode_int6
.. automethod:: encode_int12
.. automethod:: decode_int12
.. automethod:: encode_int24
.. automethod:: decode_int24
.. automethod:: encode_int64
.. automethod:: decode_int64
Informational Attributes
========================
.. attribute:: charmap
unicode string containing list of characters used in encoding;
position in string matches 6bit value of character.
.. attribute:: bytemap
bytes version of :attr:`charmap`
.. attribute:: big
boolean flag indicating this using big-endian encoding.
c C` s t | t r! | j d } n$ t | t sE t j | d n t | d k rf t d n t t | d k r t d n | | _ | j
| _ t d t
| D } | j
| _ | | _ | r | j | _ | j | _ n | j | _ | j | _ d S( Ns latin-1t charmapi@ s' charmap must be 64 characters in lengths- charmap must not contain duplicate charactersc s` s! | ] \ } } | | f Vq d S( N( ( t .0t idxt value( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys ] s ( R6 R R8 t bytesR
t ExpectedStringErrorRE RD t sett bytemapt __getitem__t _encode64t dictt enumeratet _decode64t bigt _encode_bytes_bigt
_encode_bytest _decode_bytes_bigt
_decode_bytest _encode_bytes_littlet _decode_bytes_little( t selfR[ Rh t lookup( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt __init__Q s$ c C` s | j j d S( s charmap as unicodes latin-1( Rb t decode( Ro ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR[ s s c C` s t | t s+ t d t | f n t t | d \ } } t ra t t | } n t d | D } | j | | | } t
t | j | } | S( s encode bytes to base64 string.
:arg source: byte string to encode.
:returns: byte string containing encoded data.
s source must be bytes, not %si c s` s | ] } t | Vq d S( N( R7 ( R\ t elem( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys s (
R6 R_ RI t typet divmodRE R R t iterRj R R Rd ( Ro R< t chunkst tailt
next_valuet gent out( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_bytes{ s c c` s d } xq | | k ry | } | } | } | d @V| d @d >| d ?BV| d @d >| d ?BV| d ?V| d 7} q W| r | } | d k r | d @V| d ?Vq | } | d @V| d @d >| d ?BV| d ?Vn d S(
s> helper used by encode_bytes() to handle little-endian encodingi i? i i i i i i N( ( Ro Ry Rw Rx R] t v1t v2t v3( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyRm s& c c` s d } xq | | k ry | } | } | } | d ?V| d @d >| d ?BV| d @d >| d ?BV| d @V| d 7} q W| r | } | d k r | d ?V| d @d >Vq | } | d ?V| d @d >| d ?BV| d @d >Vn d S(
s; helper used by encode_bytes() to handle big-endian encodingi i i i i i i? i N( ( Ro Ry Rw Rx R] R} R~ R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyRi s& c C` s t | t s+ t d t | f n t t | d \ } } | d k ra t d n t t | j | } y t
| j | | | SWn- t k
r } t d | j
d f n Xd S( s decode bytes from base64 string.
:arg source: byte string to decode.
:returns: byte string containing decoded data.
s source must be bytes, not %si i s( input string length cannot be == 1 mod 4s invalid character: %ri N( R6 R_ RI Rt Ru RE RD R R Rg R Rl t KeyErrort args( Ro R< Rw Rx Ry RK ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_bytes s c c` s d } xu | | k r} | } | } | } | } | | d @d >BV| d ?| d @d >BV| d ?| d >BV| d 7} q W| r | } | } | | d @d >BV| d k r | } | d ?| d @d >BVq n d S( s> helper used by decode_bytes() to handle little-endian encodingi i i i i i i N( ( Ro Ry Rw Rx R] R} R~ R t v4( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyRn s" c c` s d } xu | | k r} | } | } | } | } | d >| d ?BV| d @d >| d ?BV| d @d >| BV| d 7} q W| r | } | } | d >| d ?BV| d k r | } | d @d >| d ?BVq n d S( s; helper used by decode_bytes() to handle big-endian encodingi i i i i i i N( ( Ro Ry Rw Rx R] R} R~ R R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyRk s" c ` sU t f d t | j D } | j f d t | j D t | S( s2 helper to generate set of valid last chars & bytesc 3` s% | ] \ } } | @s | Vq d S( N( ( R\ t it c( t bits( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys G s c 3` s% | ] \ } } | @s | Vq d S( N( ( R\ R R ( R ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys H s ( Ra Rf Rb t updateR[ t frozenset( Ro R t pset( ( R s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt
__make_padsetE s %&c C` s) | j r d n d } | | j | f S( sD mask to clear padding bits, and valid last bytes (for strings 2 % 4)i i i< ( Rh t _Base64Engine__make_padset( Ro R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt _padinfo2K s c C` s) | j r d n d } | | j | f S( sD mask to clear padding bits, and valid last bytes (for strings 3 % 4)i i i0 ( Rh R ( Ro R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt _padinfo3R s c C` s t | d @} | d k r. | j \ } } n: | d k rL | j \ } } n | s\ t | f St d | d } | | k r t | f St | t r | j } | | j | | @} n4 | j | j
| | @ } t r t | g } n t
| d | f S( s helper to detect & clear invalid unused bits in last character.
:arg source:
encoded data (as ascii bytes or unicode).
:returns:
`(True, result)` if the string was repaired,
`(False, source)` if the string was ok as-is.
i i s source length must != 1 mod 4i( RE R R t FalseRD R6 R R[ t indexRd Rg R R_ RY ( Ro R< Rx t maskt padsett lastt cm( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt check_repair_unusedY s&
c C` s | j | d S( Ni ( R ( Ro R< ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt
repair_unused s c ` sT t t s+ t d t f n t f d | D } | j | S( s> encode byte string, first transposing source using offset lists source must be bytes, not %sc 3` s | ] } | Vq d S( N( ( R\ RJ ( R< ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys s ( R6 R_ RI Rt R R| ( Ro R< t offsetst tmp( ( R< s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_transposed_bytes s c C` sV | j | } d g t | } x' t | | D] \ } } | | | | | } q WWn$ t k
r t d | f n X| r| r | | L} q| d | >d M} n | S( s decode base64 string -> integer
:arg source: base64 string to decode.
:arg bits: number of bits in resulting integer.
:raises ValueError:
* if the string contains invalid base64 characters.
* if the string is not long enough - it must be at least
``int(ceil(bits/6))`` in length.
:returns:
a integer in the range ``0 <= n < 2**bits``
s source must be bytes, not %si s source must be %d charsi s invalid character in string: %ri (
R6 R_ RI Rt Rh RE RD Rg t reversedR ( Ro R< R Rh t padt charsRr R{ R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt _decode_int s&
c C` s t | t s+ t d t | f n t | d k rL t d n t r_ | d } n y | j | SWn t k
r t d n Xd S( s( decode single character -> 6 bit integers source must be bytes, not %si s source must be exactly 1 bytei s invalid characterN( R6 R_ RI Rt RE RD R Rg R ( Ro R< ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_int6 s
c C` s t | t s+ t d t | f n t | d k rL t d n | j } yM | j r | | d | | d d >S| | d | | d d >SWn t k
r t d n Xd S( s' decodes 2 char string -> 12-bit integers source must be bytes, not %si s source must be exactly 2 bytesi i i s invalid characterN( R6 R_ RI Rt RE RD Rg Rh R ( Ro R< Rr ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_int12 s $
c C` s t | t s+ t d t | f n t | d k rL t d n | j } y | j r | | d | | d d >| | d d >| | d d
>S| | d | | d d >| | d d >| | d d
>SWn t k
r t d n Xd S(
s' decodes 4 char string -> 24-bit integers source must be bytes, not %si s source must be exactly 4 bytesi i i i i i i s invalid characterN( R6 R_ RI Rt RE RD Rg Rh R ( Ro R< Rr ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_int24 s DH
c C` s | j | d S( s& decode 5 char string -> 30 bit integeri ( R ( Ro R< ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_int30 s c C` s | j | d S( s decode 11 char base64 string -> 64-bit integer
this format is used primarily by des-crypt & variants to encode
the DES output value used as a checksum.
i@ ( R ( Ro R< ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt decode_int64 s c ` sy | d } | | 7} | j rA t | d d d } | K n t d | d } t t | j f d | D S( s encode integer into base64 format
:arg value: non-negative integer to encode
:arg bits: number of bits to encode
:returns:
a string of length ``int(ceil(bits/6.0))``.
i ii c 3` s | ] } | ?d @Vq d S( i? N( ( R\ RJ ( R^ ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pys " s ( Rh R
R R Rd ( Ro R^ R R t itr( ( R^ s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt _encode_int s
c C` sP | d k s | d k r' t d n t r? | j | | d !S| j | Sd S( s0 encodes 6-bit integer -> single hash64 characteri i? s value out of rangei N( RD R Rb Rd ( Ro R^ ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_int6( s
c C` sm | d k s | d k r' t d n | d @| d ?d @g } | j rW t | } n t t | j | S( s' encodes 12-bit integer -> 2 char stringi i s value out of rangei? i ( RD Rh R R R Rd ( Ro R^ t raw( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_int121 s c C` s | d k s | d k r' t d n | d @| d ?d @| d ?d @| d ?d @g } | j rm t | } n t t | j | S( s' encodes 24-bit integer -> 4 char stringi i s value out of rangei? i i i ( RD Rh R R R Rd ( Ro R^ R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_int24: s c C` s7 | d k s | d k r' t d n | j | d S( s& decode 5 char string -> 30 bit integeri i?s value out of rangei ( RD R ( Ro R^ ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_int30D s c C` s7 | d k s | d k r' t d n | j | d S( s encode 64-bit integer -> 11 char hash64 string
this format is used primarily by des-crypt & variants to encode
the DES output value used as a checksum.
i l s value out of rangei@ ( RD R ( Ro R^ ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt encode_int64J s N(( t __name__t
__module__t __doc__R2 Rb Rh Rd Rg Rj Rl R Rq t propertyR[ R| Rm Ri R Rn Rk R R R R R R R R R R R R R R R R R R R R ( ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR& sD ? " ' + # * ) (
c B` s/ e Z d Z d Z d Z d Z d Z RS( s< Base64Engine which delays initialization until it's accessedc O` s | | f | _ d S( N( t
_lazy_opts( Ro R t kwds( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyRq \ s c C` s; | j \ } } t t | j | | | ` t | _ d S( N( R t superR' Rq R& t __class__( Ro R R ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt
_lazy_init_ s c C` s, | j d s | j n t j | | S( Nt _( t
startswithR t objectt __getattribute__( Ro t attr( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR e s
N( R R R R2 R Rq R R ( ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyR' X s
Rh (G R t
__future__R R R t base64R R R RX R RO t binasciiR R R RH t loggingt getLoggerR t logt passlibR
t passlib.utils.compatR R R
R R R R R R R R R t passlib.utils.decorR t __all__R R R R R R R R R R9 t B_NULLRP R4 R3 R2 R! R$ R% RA RG RF R" R# RV RW R R& R' R( RY R) R* ( ( ( s8 /usr/lib/python2.7/site-packages/passlib/utils/binary.pyt sn " R !
] md4.py 0000644 00000002302 14722170205 0005577 0 ustar 00 """
passlib.utils.md4 - DEPRECATED MODULE, WILL BE REMOVED IN 2.0
MD4 should now be looked up through ``passlib.crypto.digest.lookup_hash("md4").const``,
which provides unified handling stdlib implementation (if present).
"""
#=============================================================================
# issue deprecation warning for module
#=============================================================================
from warnings import warn
warn("the module 'passlib.utils.md4' is deprecated as of Passlib 1.7, "
"and will be removed in Passlib 2.0, please use "
"'lookup_hash(\"md4\").const()' from 'passlib.crypto' instead",
DeprecationWarning)
#=============================================================================
# backwards compat exports
#=============================================================================
__all__ = ["md4"]
# this should use hashlib version if available,
# and fall back to builtin version.
from passlib.crypto.digest import lookup_hash
md4 = lookup_hash("md4").const
del lookup_hash
#=============================================================================
# eof
#=============================================================================
handlers.pyo 0000644 00000227327 14722170205 0007112 0 ustar 00
Xc @ s: d Z d d l m Z d d l Z d d l Z e j e Z d d l Z d d l Z d d l
m Z d d l j
Z
d d l j Z d d l m Z m Z m Z d d l m Z d d l m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z m! Z! d d l" m# Z# m$ Z$ m% Z% m& Z& m' Z' m( Z( m) Z) d d
l* m+ Z+ m, Z, m- Z- m. Z. m/ Z/ m0 Z0 m1 Z1 m2 Z2 m0 Z0 m3 Z3 m4 Z4 m5 Z5 d d l6 m7 Z7 m8 Z8 d d
d d d d d d d d d d d d g Z9 e$ Z: e# Z; e% Z< e' Z= e( Z> d Z? d d Z@ d ZA d ZB e- d ZC e- d ZD d! ZE d" ZF eC eG d# ZH eC d$ eG eG d% ZI d$ eG d& eG d' ZJ e- d d( ZK e- d d$ d) ZL d& d* ZM d eG d& eN d+ ZO d, e f d- YZP d. eP f d/ YZQ d eP f d0 YZR d eR f d1 YZS d2 eR f d3 YZT d eR f d4 YZU d eR f d5 YZV d eR f d6 YZW d eR f d7 YZX d eX f d8 YZY d eR f d9 YZZ d: eR f d; YZ[ e j\ Z] d< e f d= YZ^ d> e^ f d? YZ_ d e^ eR f d@ YZ` d ea f dA YZb d S(B sR passlib.handler - code for implementing handlers, and global registry for handlersi( t with_statementN( t warn( t MissingBackendErrort PasslibConfigWarningt PasslibHashWarning( t PasswordHash( t get_crypt_handler( t consteqt
getrandstrt getrandbytest rngt
to_native_strt is_crypt_handlert
to_unicodet MAX_PASSWORD_SIZEt accepts_keywordt as_boolt update_mixin_classes( t BASE64_CHARSt HASH64_CHARSt PADDED_BASE64_CHARSt HEX_CHARSt UPPER_HEX_CHARSt LOWER_HEX_CHARSt ALL_BYTE_VALUES( t join_byte_valuest iranget ut native_string_typest
uascii_to_strt join_unicodet unicodet
str_to_uasciiR t unicode_or_bytes_typest PY2t int_types( t
classpropertyt deprecated_methodt parse_mc2t parse_mc3t
render_mc2t
render_mc3t GenericHandlert
StaticHandlert HasUserContextt HasRawChecksumt
HasManyIdentst HasSaltt
HasRawSaltt HasRoundst HasManyBackendst
PrefixWrapperc C s@ | r8 | r8 d d l } t | | j t | d Sd Sd S( s helper for bitsize() methodsiNi i ( t matht intt logt len( t countt charsR4 ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _bitsizeJ s i c C s t j } | } zi x^ | rv | j j d d } | j d sS | j d r` t d | S| d 7} | j } q W| SWd ~ Xd S( si
try to guess stacklevel for application warning.
looks for first frame not part of passlib.
t __name__t s passlib.tests.s passlib.i N( t inspectt currentframet f_globalst gett
startswitht maxt f_back( t startt frameR8 t name( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt guess_app_stacklevelR s
c C s- t d t d | j t d t d d S( Ns passing settings to %(handler)s.hash() is deprecated, and won't be supported in Passlib 2.0; use '%(handler)s.using(**settings).hash(secret)' insteadt handlert
stackleveli ( R t dictRF t DeprecationWarningRG ( RH t kwds( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt warn_hash_settings_deprecationd s c s2 t | j t f d t D S( s
helper to extract settings kwds from mix of context & settings kwds.
pops settings keys from kwds, returns them as a dict.
c 3 s0 | ]& } | k r | j | f Vq d S( N( t pop( t .0t key( t context_keysRL ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pys o s ( t sett context_kwdsRJ t list( RH RL ( ( RQ RL s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt extract_settings_kwdsi s t $t 0c C sL t | t s$ t j | d n t | t k rH t j t n d S( s% ensure secret has correct type & sizet secretN( t
isinstanceR! t exct ExpectedStringErrorR7 R t PasswordSizeError( RX ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt validate_secretw s c C sj t | t r | St | t rT y | j d SWqf t k
rP | j d SXn t j | d d S( s+ convert hash to unicode for identify methods utf-8s latin-1t hashN( RY R t bytest decodet UnicodeDecodeErrorRZ R[ ( R^ ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt to_unicode_for_identify~ s
c C s t | d d } | j | s3 t j | n | t | j | } t | d k rz | \ } } | | pv d f St | d k r | d d f St j | d S( s parse hash using 2-part modular crypt format.
this expects a hash of the format :samp:`{prefix}{salt}[${checksum}]`,
such as md5_crypt, and parses it into salt / checksum portions.
:arg hash: the hash to parse (bytes or unicode)
:arg prefix: the identifying prefix (unicode)
:param sep: field separator (unicode, defaults to ``$``).
:param handler: handler class to pass to error constructors.
:returns:
a ``(salt, chk | None)`` tuple.
t asciiR^ i i i N( R
RA RZ t InvalidHashErrorR7 t splitt Nonet MalformedHashError( R^ t prefixt sepRH t partst saltt chk( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR& s i
c
C s% t | d d } | j | s3 t j | n | t | j | } t | d k rp | \ } } } n6 t | d k r | \ } } d } n t j | | j t r | t k r t j | n? | r t
| | } n' | d k r t j | d n | } | | | p!d f S( sr parse hash using 3-part modular crypt format.
this expects a hash of the format :samp:`{prefix}[{rounds}]${salt}[${checksum}]`,
such as sha1_crypt, and parses it into rounds / salt / checksum portions.
tries to convert the rounds to an integer,
and throws error if it has zero-padding.
:arg hash: the hash to parse (bytes or unicode)
:arg prefix: the identifying prefix (unicode)
:param sep: field separator (unicode, defaults to ``$``).
:param rounds_base:
the numeric base the rounds are encoded in (defaults to base 10).
:param default_rounds:
the default rounds value to return if the rounds field was omitted.
if this is ``None`` (the default), the rounds field is *required*.
:param handler: handler class to pass to error constructors.
:returns:
a ``(rounds : int, salt, chk | None)`` tuple.
Rc R^ i i s empty rounds fieldN( R
RA RZ Rd R7 Re Rf Rg t _UZEROt ZeroPaddedRoundsErrorR5 (
R^ Rh Ri t rounds_baset default_roundsRH Rj t roundsRk Rl ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR' s$ t valuec C st | j t r4 | t k r4 t j | d | n< | rG t | | S| d k rl t j | d | n | Sd S( s
helper to parse an integer config field
:arg source: unicode source string
:param base: numeric base
:param default: optional default if source is empty
:param param: name of variable, for error msgs
:param handler: handler class, for error msgs
s zero-padded %s fields empty %s fieldN( RA Rm RZ Rg R5 Rf ( t sourcet baset defaultt paramRH ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt parse_int s
c C s7 | r | | | | g } n | | g } t t | S( s format hash using 2-part modular crypt format; inverse of parse_mc2()
returns native string with format :samp:`{ident}{salt}[${checksum}]`,
such as used by md5_crypt.
:arg ident: identifier prefix (unicode)
:arg salt: encoded salt (unicode)
:arg checksum: encoded checksum (unicode or None)
:param sep: separator char (unicode, defaults to ``$``)
:returns:
config or hash (native str)
( R R ( t identRk t checksumRi Rj ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR(
s c C s | d k r t d } n+ | d k r: t d | } n t | } | rg | | | | | | g } n | | | | g } t t | S( s. format hash using 3-part modular crypt format; inverse of parse_mc3()
returns native string with format :samp:`{ident}[{rounds}$]{salt}[${checksum}]`,
such as used by sha1_crypt.
:arg ident: identifier prefix (unicode)
:arg rounds: rounds field (int or None)
:arg salt: encoded salt (unicode)
:arg checksum: encoded checksum (unicode or None)
:param sep: separator char (unicode, defaults to ``$``)
:param rounds_base: base to encode rounds value (defaults to base 10)
:returns:
config or hash (native str)
R< i s %xN( Rf R R R R ( Rx Rq Rk Ry Ri Ro Rj ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR) ! s c C s t S( s
assert helper that quickly validates default value.
designed to get out of the way and reduce overhead when asserts are stripped.
( t True( RH Ru t normRv ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt validate_default_valueB s c C s t | t s' t j | d | n | | k rz d | j | | | f } | rk t | t j | } qz t | n | r | | k r d | j | | | f } | r t | t j | } q t | n | S( s
helper to normalize and validate an integer value (e.g. rounds, salt_size)
:arg value: value provided to constructor
:arg default: default value if none provided. if set to ``None``, value is required.
:arg param: name of parameter (xxx: move to first arg?)
:param min: minimum value (defaults to 1)
:param max: maximum value (default ``None`` means no maximum)
:returns: validated value
t integers+ %s: %s (%d) is too low, must be at least %ds0 %s: %s (%d) is too large, cannot be more than %d( RY R# RZ t ExpectedTypeErrorRF R R t
ValueError( RH Rr t minRB Rv t relaxedt msg( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt norm_integerK s
t MinimalHandlerc B s& e Z d Z e Z e e d Z RS( s
helper class for implementing hash handlers.
provides nothing besides a base implementation of the .using() subclass constructor.
c C sD | j } | j s d | } n t | | f t d | j d t S( Ns t
__module__t _configured( R; R t typeRJ R Rz ( t clsR RF ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt using s
( R; R t __doc__t FalseR t classmethodR ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR r s t
TruncateMixinc B s; e Z d Z e Z e Z e d d Z e d Z RS( s
PasswordHash mixin which provides a method
that will check if secret would be truncated,
and can be configured to throw an error.
.. warning::
Hashers using this mixin will generally need to override
the default PasswordHash.truncate_error policy of "True",
and will similarly want to override .truncate_verify_reject as well.
TODO: This should be done explicitly, but for now this mixin sets
these flags implicitly.
c K sU t t | j | } | d k rQ t | d d } | d k rQ | | _ qQ n | S( NRv t truncate_error( t superR R Rf R R ( R R RL t subcls( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s4 | j r0 t | | j k r0 t j | n d S( s
make sure secret won't be truncated.
NOTE: this should only be called for .hash(), not for .verify(),
which should honor the .truncate_verify_reject policy.
N( R R7 t
truncate_sizeRZ t PasswordTruncateError( R RX ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _check_truncate_policy s N(
R; R R R R t truncate_verify_rejectR Rf R R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c B ss e Z d Z d Z d Z d Z d Z d Z d Z e
Z d Z d e
d Z
e
d Z e d Z e d Z d Z e d Z d Z e d Z e d Z e d
d d d
e d Z e d
d d d
e d Z e d d Z d d Z d Z d Z e d Z e! e" d d Z# e e$ e
d Z% e d Z& RS( s4 helper class for implementing hash handlers.
GenericHandler-derived classes will have (at least) the following
constructor options, though others may be added by mixins
and by the class itself:
:param checksum:
this should contain the digest portion of a
parsed hash (mainly provided when the constructor is called
by :meth:`from_string()`).
defaults to ``None``.
:param use_defaults:
If ``False`` (the default), a :exc:`TypeError` should be thrown
if any settings required by the handler were not explicitly provided.
If ``True``, the handler should attempt to provide a default for any
missing values. This means generate missing salts, fill in default
cost parameters, etc.
This is typically only set to ``True`` when the constructor
is called by :meth:`hash`, allowing user-provided values
to be handled in a more permissive manner.
:param relaxed:
If ``False`` (the default), a :exc:`ValueError` should be thrown
if any settings are out of bounds or otherwise invalid.
If ``True``, they should be corrected if possible, and a warning
issue. If not possible, only then should an error be raised.
(e.g. under ``relaxed=True``, rounds values will be clamped
to min/max rounds).
This is mainly used when parsing the config strings of certain
hashes, whose specifications implementations to be tolerant
of incorrect values in salt strings.
Class Attributes
================
.. attribute:: ident
[optional]
If this attribute is filled in, the default :meth:`identify` method will use
it as a identifying prefix that can be used to recognize instances of this handler's
hash. Filling this out is recommended for speed.
This should be a unicode str.
.. attribute:: _hash_regex
[optional]
If this attribute is filled in, the default :meth:`identify` method
will use it to recognize instances of the hash. If :attr:`ident`
is specified, this will be ignored.
This should be a unique regex object.
.. attribute:: checksum_size
[optional]
Specifies the number of characters that should be expected in the checksum string.
If omitted, no check will be performed.
.. attribute:: checksum_chars
[optional]
A string listing all the characters allowed in the checksum string.
If omitted, no check will be performed.
This should be a unicode str.
.. attribute:: _stub_checksum
Placeholder checksum that will be used by genconfig()
in lieu of actually generating a hash for the empty string.
This should be a string of the same datatype as :attr:`checksum`.
Instance Attributes
===================
.. attribute:: checksum
The checksum string provided to the constructor (after passing it
through :meth:`_norm_checksum`).
Required Subclass Methods
=========================
The following methods must be provided by handler subclass:
.. automethod:: from_string
.. automethod:: to_string
.. automethod:: _calc_checksum
Default Methods
===============
The following methods have default implementations that should work for
most cases, though they may be overridden if the hash subclass needs to:
.. automethod:: _norm_checksum
.. automethod:: genconfig
.. automethod:: genhash
.. automethod:: identify
.. automethod:: hash
.. automethod:: verify
c K sD | | _ t t | j | | d k r@ | j | | _ n d S( N( t use_defaultsR R* t __init__Rf t _norm_checksumRy ( t selfRy R RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR L s c s | j } | r9 t | t s t j | d d q n[ t | t s t | t r| | r| t d t | j d } q t j | d d n | j } | r t
| | k r t j | d | n | s| j rt
f d | D rt d | j f qn | S( so validates checksum keyword against class requirements,
returns normalized version of checksum.
R_ Ry s% checksum should be unicode, not bytesRc R t rawc 3 s | ] } | k Vq d S( N( ( RO t c( t cs( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pys t s s! invalid characters in %s checksum( t _checksum_is_bytesRY R_ RZ R~ R R R R` t
checksum_sizeR7 t ChecksumSizeErrort checksum_charst anyR RF ( R Ry R R t cc( ( R s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR U s"
" c C s t | } | s t S| j } | d k r8 | j | S| j } | d k r` | j | d k Sy | j | t SWn t k
r t SXd S( N(
Rb R Rx Rf RA t _hash_regext matcht from_stringRz R ( R R^ Rx t pat( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt identify| s
c K s t d | f d S( sV
return parsed instance from hash/configuration string
:param \*\*context:
context keywords to pass to constructor (if applicable).
:raises ValueError: if hash is incorrectly formatted
:returns:
hash parsed into components,
for formatting / calculating checksum.
s %s must implement from_string()N( t NotImplementedError( R R^ t context( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s t d | j f d S( s render instance to hash or configuration string
:returns:
hash string with salt & digest included.
should return native string type (ascii-bytes under python 2,
unicode under python 3)
s %s must implement from_string()N( R t __class__( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt to_string s c C s | j r; | j r d | j S| j r; | j d | j Sn t | t r | j } | j p_ d | _ z | j d SWd | | _ Xn | j d S( si
placeholder used by default .genconfig() so it can avoid expense of calculating digest.
t i i R< N( R R R RY R1 Rq t
min_roundst _calc_checksum( R t orig( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _stub_checksum s
c C s t d | j f d S( s given secret; calcuate and return encoded checksum portion of hash
string, taking config from object state
calc checksum implementations may assume secret is always
either unicode or bytes, checks are performed by verify/etc.
s" %s must implement _calc_checksum()N( R R ( R RX ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c K s| | rD t | | } | rD t | | | j | j | | Sn t | | d t | } | j | | _ | j S( NR ( RU RM R R^ R] Rz R Ry R ( R RX RL t settingsR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR^ s
c K sY t | | j | | } | j } | d k rC t j | n t | j | | S( N( R] R Ry Rf RZ t MissingDigestErrorR R ( R RX R^ R R Rl ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt verify s
t
deprecateds 1.7t removeds 2.0c K sS t | | } | r+ | j | j | S| d t | } | j | _ | j S( NR ( RU R t genconfigRz R Ry R ( R RL R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c K sS | d k r t d n t | | j | | } | j | | _ | j S( Ns config must be string( Rf t TypeErrorR] R R Ry R ( R RX t configR R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt genhash s
c K s" | j | } | j d | | S( NRX ( R t _calc_needs_update( R R^ RX RL R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt needs_update s c C s t S( s;
internal helper for :meth:`needs_update`.
( R ( R RX ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR " s t salt_sizeR Rk Ry c s f d j D S( Nc 3 s$ | ] } | j k r | Vq d S( N( t _unparsed_settings( RO RP ( R ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pys 3 s ( t setting_kwds( R ( ( R s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _parsed_settings1 s t *c C s | d k r d St | t rG d d l m } | | j d } n t | t se t | } n t | } t d | d } | | | | | S( s* default method to obscure sensitive fieldsi( t ab64_encodeRc i i N( Rf RY R_ t passlib.utils.binaryR R` R R7 R ( Rr t charR t sizet clip( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _sanitize7 s c s j | t t f d j D } | rb j d k rb j | d ] s Ry N( R t objectRJ R Ry Rf Rz R t _unsafe_settings( R R^ Ry t sanitizeRL RP ( ( R R R s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt parsehashE s % c K sz y t t | j | } Wn t k
r5 i } n X| j rE t n | j } | j rv | rv t | j | | d t k
r } t
| d k r t d f q n Xt d t
t | S(
s{ given secret; calcuate and return encoded checksum portion of hash
string, taking config from object state
c s t d f d S( Ns" %s must implement _calc_checksum()( R ( R RX ( R ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt inner s t _wrapperR R c 3 s$ | ] } | t | f Vq d S( N( R ( RO t k( R ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pys s s config must be strings" %s must implement _calc_checksum()s %r should be updated to implement StaticHandler._calc_checksum() instead of StaticHandler.genhash(), support for the latter style will be removed in Passlib 1.8N( R t _StaticHandler__cc_compat_hackRf R R; RJ R RS R R t strR R RK R ( R RX t wrapper_clsR R R^ t err( ( R R s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s$
+ ( N(
R; R R R R R R R R R Rf R R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR+ { s t HasEncodingContextc B s& e Z d Z d Z d Z d d Z RS( s? helper for classes which require knowledge of the encoding usedt encodings utf-8c K s, t t | j | | p" | j | _ d S( N( R R R t default_encodingR ( R R RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s ( s encodingN( R; R R RS R Rf R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c B sk e Z d Z d
Z d d Z e d d Z e d d Z e d d d d e d d Z
RS( s7 helper for classes which require a user context keywordt userc K s# t t | j | | | _ d S( N( R R, R R ( R R RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c K s t t | j | d | | S( NR ( R R, R^ ( R RX R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR^ s c K s" t t | j | | d | | S( NR ( R R, R ( R RX R^ R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s R s 1.7R s 2.0c K s" t t | j | | d | | S( NR ( R R, R ( R RX R R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s ( s userN( R; R R RS Rf R R R^ R R% R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR, s c B s e Z d Z e Z RS( sq mixin for classes which work with decoded checksum bytes
.. todo::
document this class's usage
( R; R R Rz R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR- s c B st e Z d Z d Z d Z d Z d Z e d d d Z d d Z
e d Z e d Z e d Z
RS( s mixin for hashes which use multiple prefix identifiers
For the hashes which may use multiple identifier prefixes,
this mixin adds an ``ident`` keyword to constructor.
Any value provided is passed through the :meth:`norm_idents` method,
which takes care of validating the identifier,
as well as allowing aliases for easier specification
of the identifiers by the user.
.. todo::
document this class's usage
Class Methods
=============
.. todo:: document using() and needs_update() options
c K sv | d k r0 | d k r' t d n | } n t t | j | } | d k rr | d | d t j | _ n | S( s4
This mixin adds support for the following :meth:`~passlib.ifc.PasswordHash.using` keywords:
:param default_ident:
default identifier that will be used by resulting customized hasher.
:param ident:
supported as alternate alias for **default_ident**.
s2 'default_ident' and 'ident' are mutually exclusiveRx R N( Rf R R R. R Rz Rx t
default_ident( R R Rx RL R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR > s
c K sb t t | j | | d k r4 | j | } n! | j rI | j } n t d | | _ d S( Ns no ident specified( R R. R Rf t _norm_identR R R Rx ( R Rx RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR \ s c C s t | t r! | j d } n | j } | | k r: | S| j } | r~ y | | } Wn t k
rj q~ X| | k r~ | Sn t d | f d S( sD
helper which normalizes & validates 'ident' value.
Rc s invalid ident: %rN( RY R_ R` t ident_valuest
ident_aliasest KeyErrorR ( R Rx t ivt iaRr ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR i s
c C s t | } | j | j S( N( Rb RA R ( R R^ ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s\ t | d d } x4 | j D]) } | j | r | | t | f Sq Wt j | d S( sD extract ident prefix from hash, helper for subclasses' from_string()Rc R^ N( R
R RA R7 RZ Rd ( R R^ Rx ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _parse_ident s
N( R; R R Rf R R R Rx R R R R R R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR. s
c B s e Z d Z d Z d Z d Z e d Z e d Z e
Z d Z d Z
e d d d d Z e d e d Z d d Z d Z e e
d
Z e d Z e d Z e d d
Z RS( s2
mixin for validating salts.
This :class:`GenericHandler` mixin adds a ``salt`` keyword to the class constuctor;
any value provided is passed through the :meth:`_norm_salt` method,
which takes care of validating salt length and content,
as well as generating new salts if one it not provided.
:param salt:
optional salt string
:param salt_size:
optional size of salt (only used if no salt provided);
defaults to :attr:`default_salt_size`.
Class Attributes
================
In order for :meth:`!_norm_salt` to do its job, the following
attributes should be provided by the handler subclass:
.. attribute:: min_salt_size
The minimum number of characters allowed in a salt string.
An :exc:`ValueError` will be throw if the provided salt is too small.
Defaults to ``0``.
.. attribute:: max_salt_size
The maximum number of characters allowed in a salt string.
By default an :exc:`ValueError` will be throw if the provided salt is
too large; but if ``relaxed=True``, it will be clipped and a warning
issued instead. Defaults to ``None``, for no maximum.
.. attribute:: default_salt_size
[required]
If no salt is provided, this should specify the size of the salt
that will be generated by :meth:`_generate_salt`. By default
this will fall back to :attr:`max_salt_size`.
.. attribute:: salt_chars
A string containing all the characters which are allowed in the salt
string. An :exc:`ValueError` will be throw if any other characters
are encountered. May be set to ``None`` to skip this check (but see
in :attr:`default_salt_chars`).
.. attribute:: default_salt_chars
[required]
This attribute controls the set of characters use to generate
*new* salt strings. By default, it mirrors :attr:`salt_chars`.
If :attr:`!salt_chars` is ``None``, this attribute must be specified
in order to generate new salts. Aside from that purpose,
the main use of this attribute is for hashes which wish to generate
salts from a restricted subset of :attr:`!salt_chars`; such as
accepting all characters, but only using a-z.
Instance Attributes
===================
.. attribute:: salt
This instance attribute will be filled in with the salt provided
to the constructor (as adapted by :meth:`_norm_salt`)
Subclassable Methods
====================
.. automethod:: _norm_salt
.. automethod:: _generate_salt
i c C s | j S( s/ default salt size (defaults to *max_salt_size*)( t
max_salt_size( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt default_salt_size s c C s | j S( sD charset used to generate new salt strings (defaults to *salt_chars*)( t
salt_chars( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt default_salt_chars s R9 c s | d k r0 | d k r' t d n | } n t t | j | } | j d } | d k r t | t r t | } n | j | d d d | | _
n d k r | j d | t f d | _
n | S( NsB 'salt_size' and 'default_salt_size' aliases are mutually exclusiveR Rv R c s S( N( ( ( Rk ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt & s ( Rf R R R/ R R@ RY R R5 t _clip_to_valid_salt_sizeR t
_norm_saltR t _generate_salt( R R R Rk RL R R ( ( Rk s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s R c C s | j } | j } | | k rl | | k rh d | j | | | f } | rY t | t qh t | n | S| | k r d | j | | | f } | r t | t | } q t | n | r| | k rd | j | | | f } | rt | t | } qt | n | S( s
internal helper --
clip salt size value to handler's absolute limits (min_salt_size / max_salt_size)
:param relaxed:
if ``True`` (the default), issues PasslibHashWarning is rounds are outside allowed range.
if ``False``, raises a ValueError instead.
:param param:
optional name of parameter to insert into error/warning messages.
:returns:
clipped rounds value
s %s: %s (%d) must be exactly %ds$ %s: %s (%r) below min_salt_size (%d)s$ %s: %s (%r) above max_salt_size (%d)( t
min_salt_sizeR RF R R R ( R R Rv R t mnt mxR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR + s,
c K se t t | j | | d k r4 | j | } n$ | j rL | j } n t d | | _ d S( Ns no salt specified( R R/ R Rf t _parse_saltR R R Rk ( R Rk RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR _ s c C s
| j | S( N( R ( R Rk ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR k s c
s | j r3 t | t s t j | d d q n t | t s t | t ro t s] | ro | j d } q t j | d d n | j d k r t
f d | D r t d | j n | j
} | r/t | | k r/d | j | | j k r
d n d | | j f } t | n | j } | rt | | k rd
| j | | k rkd n d | | j f } | rt | t | j | | } qt | n | S(
sT helper to normalize & validate user-provided salt string
:arg salt:
salt string
:raises TypeError:
If salt not correct type.
:raises ValueError:
* if salt contains chars that aren't in :attr:`salt_chars`.
* if salt contains less than :attr:`min_salt_size` characters.
* if ``relaxed=False`` and salt has more than :attr:`max_salt_size`
characters (if ``relaxed=True``, the salt is truncated
and a warning is issued instead).
:returns:
normalized salt
R_ Rk Rc R c 3 s | ] } | k Vq d S( N( ( RO R ( t sc( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pys s s invalid characters in %s salts% salt too small (%s requires %s %d %s)t exactlys >=s% salt too large (%s requires %s %d %s)s <=N( t _salt_is_bytesRY R_ RZ R~ R R" R` R Rf R R RF R R7 R t
_salt_unitR R t _truncate_salt( R Rk R R R R ( ( R s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR n s0 ( ( %
c C s | | S( N( ( Rk R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s t t | j | j S( sU
helper method for _init_salt(); generates a new random salt string.
( R R
R R ( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c K sJ t t | j | } | d k r0 | j } n t | | j | d <| S( s8 [experimental method] return info about bitsizes of hashRk N( R R/ R Rf R R: R ( R R RL R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s
N( R; R R R Rf R R R$ R R R R R Rk R R Rz R R R R R R R R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR/ s. E 3 9c B s/ e Z d Z e Z e Z d Z e d Z RS( s mixin for classes which use decoded salt parameter
A variant of :class:`!HasSalt` which takes in decoded bytes instead of an encoded string.
.. todo::
document this class's usage
R_ c C s t t | j S( N( R R
R ( R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s (
R; R R R R Rz R R R R ( ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR0 s
c B s e Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z e
d d d d d d d d Z e
d
Z e
d Z d d Z d
Z e
e d d Z e
d Z d Z e
d d d Z RS( s3 mixin for validating rounds parameter
This :class:`GenericHandler` mixin adds a ``rounds`` keyword to the class
constuctor; any value provided is passed through the :meth:`_norm_rounds`
method, which takes care of validating the number of rounds.
:param rounds: optional number of rounds hash should use
Class Attributes
================
In order for :meth:`!_norm_rounds` to do its job, the following
attributes must be provided by the handler subclass:
.. attribute:: min_rounds
The minimum number of rounds allowed. A :exc:`ValueError` will be
thrown if the rounds value is too small. Defaults to ``0``.
.. attribute:: max_rounds
The maximum number of rounds allowed. A :exc:`ValueError` will be
thrown if the rounds value is larger than this. Defaults to ``None``
which indicates no limit to the rounds value.
.. attribute:: default_rounds
If no rounds value is provided to constructor, this value will be used.
If this is not specified, a rounds value *must* be specified by the
application.
.. attribute:: rounds_cost
[required]
The ``rounds`` parameter typically encodes a cpu-time cost
for calculating a hash. This should be set to ``"linear"``
(the default) or ``"log2"``, depending on how the rounds value relates
to the actual amount of time that will be required.
Class Methods
=============
.. todo:: document using() and needs_update() options
Instance Attributes
===================
.. attribute:: rounds
This instance attribute will be filled in with the rounds value provided
to the constructor (as adapted by :meth:`_norm_rounds`)
Subclassable Methods
====================
.. automethod:: _norm_rounds
i t lineart min_desired_roundst max_desired_roundsR t
max_roundsRp t vary_roundsc
K s | d k r0 | d k r' t d n | } n | d k r` | d k rW t d n | } n | d k r | d k r | } n | d k r | } n | d k r | } q n t t | j | } | j d }
| d k r t } | j } nB t } t | t
rt | } n | j | d d d |
| _ | d k rM| j
} n t | t
rkt | } n | r| | k rd | j | | f } | rt | qt | t | } n | j | d d d |
| _
| d k rt | t
rt | } n | r7| | k r7t d | j | | f n1 | rh| | k rht d | j | | f n | j | d d
d |
| _ n | j d k r| j | j | _ n | d k rt | t
r| j d rt | d d
} qd | k r t | } qt | } n | d k rCt d | j | f nX t | t r}| d k rt d | j | f qn t | t st d n | rt d t n | | _ n | S( NsD 'min_rounds' and 'min_desired_rounds' aliases are mutually exclusivesD 'max_rounds' and 'max_desired_rounds' aliases are mutually exclusiveR Rv R s9 %s: max_desired_rounds (%r) below min_desired_rounds (%r)R s5 %s: default_rounds (%r) below min_desired_rounds (%r)s5 %s: default_rounds (%r) above max_desired_rounds (%r)Rp t %ig{Gz?t .i s %s: vary_rounds (%r) below 0i s %s: vary_rounds (%r) above 1.0s vary_rounds must be int or floats\ The 'vary_rounds' option is deprecated as of Passlib 1.7, and will be removed in Passlib 2.0( Rf R R R1 R R@ R R Rz RY R R5 t _norm_roundsR RF R R R Rp t _clip_to_desired_roundst endswitht floatR (
R R R Rp R R R Rq RL R R t explicit_min_roundsR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR 6 s
c C sB | j p d } | | k r | S| j } | r> | | k r> | S| S( s|
helper for :meth:`_generate_rounds` --
clips rounds value to desired min/max set by class (if any)
i ( R R ( R Rq t mndt mxd( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s | j } d } t | t rY | j d k rF d | >} d } n t | | } n | | | t } | | | t } | j | | j | f S( s
helper for :meth:`_generate_rounds` --
returns range for vary rounds generation.
:returns:
(lower, upper) limits suitable for random.randint()
c S s | S( N( ( Rr t upper( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt linear_to_native s t log2i c S sO | d k r d S| r, t t j | d St t j t j | d Sd S( Ni i ( R5 R4 R6 t ceil( Rr R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s
( R RY R t rounds_costR5 R Rz R ( R Rp R R t lowerR ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyt _calc_vary_rounds_range s
c K se t t | j | | d k r4 | j | } n$ | j rL | j } n t d | | _ d S( Ns no rounds specified( R R1 R Rf t
_parse_roundsR t _generate_roundsR Rq ( R Rq RL ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C s
| j | S( N( R ( R Rq ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s Rq c C s% t | | | j | j d | d | S( s
helper for normalizing rounds value.
:arg rounds:
an integer cost parameter.
:param relaxed:
if ``True`` (the default), issues PasslibHashWarning is rounds are outside allowed range.
if ``False``, raises a ValueError instead.
:param param:
optional name of parameter to insert into error/warning messages.
:raises TypeError:
* if ``use_defaults=False`` and no rounds is specified
* if rounds is not an integer.
:raises ValueError:
* if rounds is ``None`` and class does not specify a value for
:attr:`default_rounds`.
* if ``relaxed=False`` and rounds is outside bounds of
:attr:`min_rounds` and :attr:`max_rounds` (if ``relaxed=True``,
the rounds value will be clamped, and a warning issued).
:returns:
normalized rounds value
Rv R ( R R R ( R Rq R Rv ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR s c C st | j } | d k r. t d | j f n | j rp | j | \ } } | | k rp t j | | } qp n | S( s
internal helper for :meth:`_norm_rounds` --
returns default rounds value, incorporating vary_rounds,
and any other limitations hash may place on rounds parameter.
s, %s rounds value must be specified explicitlyN( Rp Rf R RF R R R
t randint( R Rq R
R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR
s c K sZ | j } | r" | j | k r" t S| j } | rD | j | k rD t St t | j | S( sR
mark hash as needing update if rounds is outside desired bounds.
( R Rq Rz R R R1 R ( R RL R R ( ( s: /usr/lib/python2.7/site-packages/passlib/utils/handlers.pyR ) s g?c K s t t | j | } | j d k r{ d d l } | d k rK | j } n t d t d | j | | d | d