hansel._check_is_subset() - Code Metrics - Inspection of "Merge branch 'join'" - alexsavio/hansel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a95b57...038136 )

by Alexandre M.

created 2016-02-11 10:21 UTC

hansel._check_is_subset() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	2
dl	0
loc	5
rs	9.4285

# -*- coding: utf-8 -*-
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
"""
Crumb manipulation utilities
"""
import functools
import os
import os.path as op
import warnings

from   six import string_types


def _dict_popitems(adict, **kwargs):
    if not adict:
        return

    if not kwargs:
        return

    _ = [adict.pop(k) for k in kwargs if k in adict]


def _get_path(crumb_path):
    """ Return the path string from `crumb_path`.
    Parameters
    ----------
    crumb_path: str or Crumb

    Returns
    -------
    path: str
    """
    if hasattr(crumb_path, '_path'):
        crumb_path = crumb_path._path

    if not isinstance(crumb_path, string_types):
        raise TypeError("Expected `crumb_path` to be a {}, got {}.".format(string_types, type(crumb_path)))

    return crumb_path


def _is_crumb_arg(crumb_arg, start_end_syms=('{', '}')):
    """ Returns True if `crumb_arg` is a well formed crumb argument, i.e.,
    is a string that starts with `start_sym` and ends with `end_sym`. False otherwise."""
    if not isinstance(crumb_arg, string_types):
        return False

    start_sym, end_sym = start_end_syms
    return crumb_arg.startswith(start_sym) and crumb_arg.endswith(end_sym)


def _arg_params(arg, start_end_syms=('{', '}'), reg_sym=':'):
    """ Return the name and the regex of the argument given its crumb representation.
    Parameters
    ----------
    arg_crumb: str

    start_end_syms: 2-tuple of str
        The strings that indicate the start and end of a crumb argument

    reg_sym: str
        The string that separate the crumb argument name from the
        crumb argument regular expression.

    Returns
    -------
    arg_name: str

    arg_regex: str
    """
    arg_content = _arg_content(arg, start_end_syms=start_end_syms)

    if reg_sym in arg_content:
        return tuple(arg_content.split(reg_sym))
    else:
        return arg_content, None


def _arg_name(arg, start_end_syms=('{', '}'), reg_sym=':'):
    """ Return the name of the argument given its crumb representation.
    Parameters
    ----------
    arg_crumb: str

    start_end_syms: 2-tuple of str
        The strings that indicate the start and end of a crumb argument

    reg_sym: str
        The string that separate the crumb argument name from the
        crumb argument regular expression.

    Returns
    -------
    arg_name: str
    """
    arg_content = _arg_content(arg, start_end_syms=start_end_syms)

    if reg_sym in arg_content:
        return arg_content.split(reg_sym)[0]
    else:
        return arg_content


def _arg_regex(arg, start_end_syms=('{', '}'), reg_sym=':'):
    """ Return the name of the argument given its crumb representation.
    Parameters
    ----------
    arg_crumb: str

    start_end_syms: 2-tuple of str
        The strings that indicate the start and end of a crumb argument

    reg_sym: str
        The string that separate the crumb argument name from the
        crumb argument regular expression.

    Returns
    -------
    arg_name: str
    """
    arg_content = _arg_content(arg, start_end_syms=start_end_syms)

    if reg_sym in arg_content:
        return arg_content.split(reg_sym)[1]
    else:
        return None


def _arg_content(arg, start_end_syms=('{', '}')):
    """ Return the name of the argument given its crumb representation.
    Parameters
    ----------
    arg_crumb: str

    start_end_syms: 2-tuple of str
        The strings that indicate the start and end of a crumb argument

    Returns
    -------
    arg_name: str
    """
    if not _is_crumb_arg(arg):
        raise ValueError("Expected an well formed crumb argument, "
                         "got {}.".format(arg))

    start_sym, end_sym = start_end_syms
    return arg[len(start_sym):-len(end_sym)]


def _arg_format(arg_name, start_end_syms=('{', '}'), reg_sym=':', regex=None):
    """ Return the crumb argument for its string `format()` representation.
    Parameters
    ----------
    arg_name: str

    Returns
    -------
    arg_format: str
    """
    start_sym, end_sym = start_end_syms

    arg_fmt = start_sym + arg_name
    if regex is not None:
        arg_fmt += reg_sym + regex
    arg_fmt += end_sym

    return arg_fmt


def is_valid(crumb_path, start_end_syms=('{', '}')):
    """ Return True if `crumb_path` is a well formed path with crumb arguments,
    False otherwise.
    Parameters
    ----------
    crumb_path: str

    Returns
    -------
    is_valid: bool
    """
    crumb_path = _get_path(crumb_path)

    start_sym, end_sym = start_end_syms

    splt = crumb_path.split(op.sep)
    for crumb in splt:
        if op.isdir(crumb):
            continue

        if _is_crumb_arg(crumb, start_end_syms=start_end_syms):
            crumb = _arg_name(crumb, start_end_syms=start_end_syms)

        if start_sym in crumb or end_sym in crumb:
            return False

    return True


def has_crumbs(crumb_path, start_end_syms=('{', '}')):
    """ Return True if the `crumb_path.split(op.sep)` has item which is a crumb argument
    that starts with '{' and ends with '}'."""
    crumb_path = _get_path(crumb_path)

    splt = crumb_path.split(op.sep)
    for i in splt:
        if _is_crumb_arg(i, start_end_syms=start_end_syms):
            return True

    return False


def _replace(crumb_path, start_end_syms=('{', '}'), regexes=None, **kwargs):
    """ Return `crumb_path` where every crumb argument found in `kwargs` has been
    replaced by the given value in `kwargs."""
    if not kwargs:
        return crumb_path

    if regexes is None:
        regexes = {}

    for k in kwargs:
        karg = _arg_format(k, start_end_syms=start_end_syms, regex=regexes.get(k, None))
        if k not in crumb_path:
            raise KeyError("Could not find argument {} in"
                           " `crumb_path` {}.".format(k, crumb_path))

        crumb_path = crumb_path.replace(karg, kwargs[k])

    return crumb_path


def _split(crumb_path, start_end_syms=('{', '}')):
    """ Split `crumb_path` in two parts, the first is the base folder without any crumb argument
        and the second is the rest of `crumb_path` beginning with the first crumb argument.
        If `crumb_path` has no crumb arguments or starts with a crumb argument, return `crumb_path`.
    """
    crumb_path = _get_path(crumb_path)

    if not has_crumbs(crumb_path, start_end_syms=start_end_syms):
        return crumb_path

    if not is_valid(crumb_path, start_end_syms=start_end_syms):
        raise ValueError('Crumb path {} is not valid.'.format(crumb_path))

    start_sym, _ = start_end_syms
    if crumb_path.startswith(start_sym):
        return crumb_path

    idx = crumb_path.find(start_sym)
    base = crumb_path[0:idx]
    if base.endswith(op.sep):
        base = base[:-1]

    rest = crumb_path[idx:]

    return base, rest


def _touch(crumb_path, exist_ok=True, start_end_syms=('{', '}')):
    """ Create a leaf directory and all intermediate ones
    using the non crumbed part of `crumb_path`.
    If the target directory already exists, raise an IOError
    if exist_ok is False. Otherwise no exception is raised.
    Parameters
    ----------
    crumb_path: str

    exist_ok: bool
        Default = True

    Returns
    -------
    nupath: str
        The new path created.
    """
    if has_crumbs(crumb_path, start_end_syms=start_end_syms):
        nupath = _split(crumb_path, start_end_syms=start_end_syms)[0]
    else:
        nupath = crumb_path

    if op.exists(nupath) and not exist_ok:
        raise IOError("Folder {} already exists.".format(nupath))

    try:
        os.makedirs(nupath)
    except:
        raise
    else:
        return nupath


def _split_exists(crumb_path, start_end_syms=('{', '}')):
    """ Return True if the part without crumb arguments of `crumb_path`
    is an existing path or a symlink, False otherwise.
    Returns
    -------
    exists: bool
    """
    if has_crumbs(crumb_path):
        rpath = _split(crumb_path, start_end_syms=start_end_syms)[0]
    else:
        rpath = str(crumb_path)

    return op.exists(rpath) or op.islink(rpath)


def _check_is_subset(list1, list2):
    """ Raise an error if `list1` is not a subset of `list2`."""
    if not set(list1).issubset(list2):
        raise KeyError('The `list1` argument should be a subset of `list2`, '
                       'got {} and {}.'.format(list1, list2))


def deprecated(replacement=None):
    """A decorator which can be used to mark functions as deprecated.
    replacement is a callable that will be called with the same args
    as the decorated function.

    >>> @deprecated()
    ... def foo(x):
    ...     return x
    ...
    >>> ret = foo(1)
    DeprecationWarning: foo is deprecated
    >>> ret
    1
    >>>
    >>>
    >>> def newfun(x):
    ...     return 0
    ...
    >>> @deprecated(newfun)
    ... def foo(x):
    ...     return x
    ...
    >>> ret = foo(1)
    DeprecationWarning: foo is deprecated; use newfun instead
    >>> ret
    0
    >>>
    """
    def outer(fun):
        msg = "psutil.%s is deprecated" % fun.__name__
        if replacement is not None:
            msg += "; use %s instead" % replacement
        if fun.__doc__ is None:
            fun.__doc__ = msg

        @functools.wraps(fun)
        def inner(*args, **kwargs):
            warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
            return fun(*args, **kwargs)

        return inner
    return outer


1			# -- coding: utf-8 --
2			# emacs: -- mode: python; py-indent-offset: 4; indent-tabs-mode: nil --
3			# vi: set ft=python sts=4 ts=4 sw=4 et:
4			"""
5			Crumb manipulation utilities
6			"""
7			import functools
8			import os
9			import os.path as op
10			import warnings
11
12			from six import string_types
13
14
15			def _dict_popitems(adict, **kwargs):
16			if not adict:
17			return
18
19			if not kwargs:
20			return
21
22			_ = [adict.pop(k) for k in kwargs if k in adict]
23
24
25			def _get_path(crumb_path):
26			""" Return the path string from `crumb_path`.
27			Parameters
28			----------
29			crumb_path: str or Crumb
30
31			Returns
32			-------
33			path: str
34			"""
35			if hasattr(crumb_path, '_path'):
36			crumb_path = crumb_path._path
37
38			if not isinstance(crumb_path, string_types):
39			raise TypeError("Expected `crumb_path` to be a {}, got {}.".format(string_types, type(crumb_path)))
40
41			return crumb_path
42
43
44			def _is_crumb_arg(crumb_arg, start_end_syms=('{', '}')):
45			""" Returns True if `crumb_arg` is a well formed crumb argument, i.e.,
46			is a string that starts with `start_sym` and ends with `end_sym`. False otherwise."""
47			if not isinstance(crumb_arg, string_types):
48			return False
49
50			start_sym, end_sym = start_end_syms
51			return crumb_arg.startswith(start_sym) and crumb_arg.endswith(end_sym)
52
53
54			def _arg_params(arg, start_end_syms=('{', '}'), reg_sym=':'):
55			""" Return the name and the regex of the argument given its crumb representation.
56			Parameters
57			----------
58			arg_crumb: str
59
60			start_end_syms: 2-tuple of str
61			The strings that indicate the start and end of a crumb argument
62
63			reg_sym: str
64			The string that separate the crumb argument name from the
65			crumb argument regular expression.
66
67			Returns
68			-------
69			arg_name: str
70
71			arg_regex: str
72			"""
73			arg_content = _arg_content(arg, start_end_syms=start_end_syms)
74
75			if reg_sym in arg_content:
76			return tuple(arg_content.split(reg_sym))
77			else:
78			return arg_content, None
79
80
81			def _arg_name(arg, start_end_syms=('{', '}'), reg_sym=':'):
82			""" Return the name of the argument given its crumb representation.
83			Parameters
84			----------
85			arg_crumb: str
86
87			start_end_syms: 2-tuple of str
88			The strings that indicate the start and end of a crumb argument
89
90			reg_sym: str
91			The string that separate the crumb argument name from the
92			crumb argument regular expression.
93
94			Returns
95			-------
96			arg_name: str
97			"""
98			arg_content = _arg_content(arg, start_end_syms=start_end_syms)
99
100			if reg_sym in arg_content:
101			return arg_content.split(reg_sym)[0]
102			else:
103			return arg_content
104
105
106			def _arg_regex(arg, start_end_syms=('{', '}'), reg_sym=':'):
107			""" Return the name of the argument given its crumb representation.
108			Parameters
109			----------
110			arg_crumb: str
111
112			start_end_syms: 2-tuple of str
113			The strings that indicate the start and end of a crumb argument
114
115			reg_sym: str
116			The string that separate the crumb argument name from the
117			crumb argument regular expression.
118
119			Returns
120			-------
121			arg_name: str
122			"""
123			arg_content = _arg_content(arg, start_end_syms=start_end_syms)
124
125			if reg_sym in arg_content:
126			return arg_content.split(reg_sym)[1]
127			else:
128			return None
129
130
131			def _arg_content(arg, start_end_syms=('{', '}')):
132			""" Return the name of the argument given its crumb representation.
133			Parameters
134			----------
135			arg_crumb: str
136
137			start_end_syms: 2-tuple of str
138			The strings that indicate the start and end of a crumb argument
139
140			Returns
141			-------
142			arg_name: str
143			"""
144			if not _is_crumb_arg(arg):
145			raise ValueError("Expected an well formed crumb argument, "
146			"got {}.".format(arg))
147
148			start_sym, end_sym = start_end_syms
149			return arg[len(start_sym):-len(end_sym)]
150
151
152			def _arg_format(arg_name, start_end_syms=('{', '}'), reg_sym=':', regex=None):
153			""" Return the crumb argument for its string `format()` representation.
154			Parameters
155			----------
156			arg_name: str
157
158			Returns
159			-------
160			arg_format: str
161			"""
162			start_sym, end_sym = start_end_syms
163
164			arg_fmt = start_sym + arg_name
165			if regex is not None:
166			arg_fmt += reg_sym + regex
167			arg_fmt += end_sym
168
169			return arg_fmt
170
171
172			def is_valid(crumb_path, start_end_syms=('{', '}')):
173			""" Return True if `crumb_path` is a well formed path with crumb arguments,
174			False otherwise.
175			Parameters
176			----------
177			crumb_path: str
178
179			Returns
180			-------
181			is_valid: bool
182			"""
183			crumb_path = _get_path(crumb_path)
184
185			start_sym, end_sym = start_end_syms
186
187			splt = crumb_path.split(op.sep)
188			for crumb in splt:
189			if op.isdir(crumb):
190			continue
191
192			if _is_crumb_arg(crumb, start_end_syms=start_end_syms):
193			crumb = _arg_name(crumb, start_end_syms=start_end_syms)
194
195			if start_sym in crumb or end_sym in crumb:
196			return False
197
198			return True
199
200
201			def has_crumbs(crumb_path, start_end_syms=('{', '}')):
202			""" Return True if the `crumb_path.split(op.sep)` has item which is a crumb argument
203			that starts with '{' and ends with '}'."""
204			crumb_path = _get_path(crumb_path)
205
206			splt = crumb_path.split(op.sep)
207			for i in splt:
208			if _is_crumb_arg(i, start_end_syms=start_end_syms):
209			return True
210
211			return False
212
213
214			def _replace(crumb_path, start_end_syms=('{', '}'), regexes=None, **kwargs):
215			""" Return `crumb_path` where every crumb argument found in `kwargs` has been
216			replaced by the given value in `kwargs."""
217			if not kwargs:
218			return crumb_path
219
220			if regexes is None:
221			regexes = {}
222
223			for k in kwargs:
224			karg = _arg_format(k, start_end_syms=start_end_syms, regex=regexes.get(k, None))
225			if k not in crumb_path:
226			raise KeyError("Could not find argument {} in"
227			" `crumb_path` {}.".format(k, crumb_path))
228
229			crumb_path = crumb_path.replace(karg, kwargs[k])
230
231			return crumb_path
232
233
234			def _split(crumb_path, start_end_syms=('{', '}')):
235			""" Split `crumb_path` in two parts, the first is the base folder without any crumb argument
236			and the second is the rest of `crumb_path` beginning with the first crumb argument.
237			If `crumb_path` has no crumb arguments or starts with a crumb argument, return `crumb_path`.
238			"""
239			crumb_path = _get_path(crumb_path)
240
241			if not has_crumbs(crumb_path, start_end_syms=start_end_syms):
242			return crumb_path
243
244			if not is_valid(crumb_path, start_end_syms=start_end_syms):
245			raise ValueError('Crumb path {} is not valid.'.format(crumb_path))
246
247			start_sym, _ = start_end_syms
248			if crumb_path.startswith(start_sym):
249			return crumb_path
250
251			idx = crumb_path.find(start_sym)
252			base = crumb_path[0:idx]
253			if base.endswith(op.sep):
254			base = base[:-1]
255
256			rest = crumb_path[idx:]
257
258			return base, rest
259
260
261			def _touch(crumb_path, exist_ok=True, start_end_syms=('{', '}')):
262			""" Create a leaf directory and all intermediate ones
263			using the non crumbed part of `crumb_path`.
264			If the target directory already exists, raise an IOError
265			if exist_ok is False. Otherwise no exception is raised.
266			Parameters
267			----------
268			crumb_path: str
269
270			exist_ok: bool
271			Default = True
272
273			Returns
274			-------
275			nupath: str
276			The new path created.
277			"""
278			if has_crumbs(crumb_path, start_end_syms=start_end_syms):
279			nupath = _split(crumb_path, start_end_syms=start_end_syms)[0]
280			else:
281			nupath = crumb_path
282
283			if op.exists(nupath) and not exist_ok:
284			raise IOError("Folder {} already exists.".format(nupath))
285
286			try:
287			os.makedirs(nupath)
288			except:
289			raise
290			else:
291			return nupath
292
293
294			def _split_exists(crumb_path, start_end_syms=('{', '}')):
295			""" Return True if the part without crumb arguments of `crumb_path`
296			is an existing path or a symlink, False otherwise.
297			Returns
298			-------
299			exists: bool
300			"""
301			if has_crumbs(crumb_path):
302			rpath = _split(crumb_path, start_end_syms=start_end_syms)[0]
303			else:
304			rpath = str(crumb_path)
305
306			return op.exists(rpath) or op.islink(rpath)
307
308
309			def _check_is_subset(list1, list2):
310			""" Raise an error if `list1` is not a subset of `list2`."""
311			if not set(list1).issubset(list2):
312			raise KeyError('The `list1` argument should be a subset of `list2`, '
313			'got {} and {}.'.format(list1, list2))
314
315
316			def deprecated(replacement=None):
317			"""A decorator which can be used to mark functions as deprecated.
318			replacement is a callable that will be called with the same args
319			as the decorated function.
320
321			>>> @deprecated()
322			... def foo(x):
323			... return x
324			...
325			>>> ret = foo(1)
326			DeprecationWarning: foo is deprecated
327			>>> ret
328			1
329			>>>
330			>>>
331			>>> def newfun(x):
332			... return 0
333			...
334			>>> @deprecated(newfun)
335			... def foo(x):
336			... return x
337			...
338			>>> ret = foo(1)
339			DeprecationWarning: foo is deprecated; use newfun instead
340			>>> ret
341			0
342			>>>
343			"""
344			def outer(fun):
345			msg = "psutil.%s is deprecated" % fun.__name__
346			if replacement is not None:
347			msg += "; use %s instead" % replacement
348			if fun.__doc__ is None:
349			fun.__doc__ = msg
350
351			@functools.wraps(fun)
352			def inner(args, *kwargs):
353			warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
354			return fun(args, *kwargs)
355
356			return inner
357			return outer
358

alexsavio / hansel

Push — master ( a95b57...038136 )

hansel._check_is_subset() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like