schedule: 'every week'

language: python

cache: pip

python:

- '3.5'

- '3.6'

- 'nightly' # currently 3.7

matrix:

allow_failures:

- python: 'nightly'

install:

- make install

- pip freeze

script:

- make lint

- make test

- ./tests/check_tag.py

after_success:

- ls -lha

- bash <(curl -s https://codecov.io/bash)

env:

- secure: "vpTd8bkwPBP0CV3EJBAwSMNMnNK3m/71dvTvBd1T4YGuefyJvYhtA7wauA5xRL9jpK2mu5QR5eo0owTUJhKi4DjpafMMd1bc4PnXlrdZFzkn3VsGmlKt74D/aJgiuiNyhd/Qvq4OxMHrMhf4f6lKWoMM1vh6yT0yp3+51SexSh2Me0Q+npxbjXwoxX5XUHRcoSLtFk4GbYI88a2I+08XWI6v+Awo/giQ5QurUJhjAklbosrrQVr1FCOkU0em5jeyZvEbZSLmaMtbX1JlRdKoJm6WMU+y9I7zj35w6ue/vgfcLz7b/HDZrBx7/L9g1LxRo80briueX/IbHvN7DOVFKvaXVmnEa6lIDdCeOLOyESpIbmjqmDKi8JeexdPNxKq4Tvo2VEA9dL2w2aw+aALNtU2OF5iEMfPTUQyosu/CNu2PKtiuZkSOdvpYbSy1WUNHJRvomdR4Olzg8ZIScNsxU3IIPdrlG/LUA8auXcE9juFeZfD6D2hQZATqWeEe/C2J7amNSD+mLLaTf6nMQw8oNtKYOvYK17M7xyvi7HXDy711Bi18U3x6Ye0xGx8CDbFwl0ICNzIk9rrSAh9hEHTvfdUUkk35pxifvO0Hrh4SArCA20ozcH/hHWBhyqGdxoIQ6KoDgNbIFIGQ6/vugxL/pt8z1sJwPfJnq8tRDAyWZvE="

deploy:

- provider: pypi

user: samuelcolvin

password:

secure: QbXFF2puEWjhFUpD0yu2R+wP4QI1IKIomBkMizsiCyMutlexERElranyYB8bsakvjPaJ+zU14ufffh2u7UA7Zhep/iE4skRHq4XWxnnRLHGu5nyGf3+zSM3F9MOzV32eZ4CDLJtFb6I0ensjTpodJH2EsIYHYxTgndIZn56Qbh6CStj7Xg1zm0Ujxdzm4ZLgcS28SOF/tpjsDW9+GXwc6L1mAZWYiS98gVgzL1vBd9tL9uFbbuFwGz9uhFMzFJko7vXSl8urWB4qeCspKXa9iKH7/AOYSwXTCwcg8U2hhC9UsOapnga2BubZKlU5HRfSs9fQcpnzcP2lwhSmkrEFa8VOw83hX6+bL564xK1Q4kanfGZ1fLU4FYge3iOnqjH7ajO7xEcUrcOEYUPfxM4EfdiDw0xnAzE1ITGH1/pZikF+wjlu+ez7RmmnejgK7quT1WU7keo7pSlRSfQtNgNl6xu818x0xZ1TScfN6e9npNy4TYyIooMOOeI4tMdfcR4JClkjGKhAtBk81DH7isZgPv3uwocGnKZ2S7La97CE3ADzU3MTA9xVIOSOjzwuvAe72uS2nwzqXkS9KATdATkC9QCvheJ9jIBB4UcqnHbD8L1gkqdmZwXZqHZldq8wcqNYZb+81lumy5EZ6xSoEzlLDpXHe80EjMUOBkb5fz3D44s=

distributions: sdist bdist_wheel

skip_upload_docs: true

on:

tags: true

python: 3.6

- provider: script

script: make publish

on:

tags: true

python: 3.6

The MIT License (MIT)

Copyright (c) 2017 Samuel Colvin

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

.DEFAULT_GOAL := all

.PHONY: install

install:

pip install -U setuptools pip

pip install -r requirements.txt

pip install -U .

.PHONY: isort

isort:

isort -rc -w 120 devtools

isort -rc -w 120 tests

.PHONY: lint

lint:

python setup.py check -rms

flake8 devtools/ tests/

pytest devtools -p no:sugar -q

.PHONY: test

test:

pytest --cov=devtools

.PHONY: testcov

testcov:

pytest --cov=devtools

@echo "building coverage html"

@coverage html

.PHONY: all

all: testcov lint

.PHONY: clean

clean:

rm -rf `find . -name __pycache__`

rm -f `find . -type f -name '*.py[co]' `

rm -f `find . -type f -name '*~' `

rm -f `find . -type f -name '.*~' `

rm -rf .cache

rm -rf htmlcov

rm -rf *.egg-info

rm -f .coverage

rm -f .coverage.*

rm -rf build

python setup.py clean

make -C docs clean

.PHONY: docs

docs:

make -C docs html

.PHONY: docs-lint

docs-lint:

make -C docs lint

python devtools

|BuildStatus| |Coverage| |pypi|

Dev tools for python. **WIP**

Usage

.. code:: python

Usage without Import

modify ``/usr/lib/python3.6/sitecustomize.py`` making ``debug`` available in any python 3.6 code

.. code:: python

.. |BuildStatus| image:: https://travis-ci.org/samuelcolvin/python-devtools.svg?branch=master

:target: https://travis-ci.org/samuelcolvin/python-devtools

.. |Coverage| image:: https://codecov.io/gh/samuelcolvin/python-devtools/branch/master/graph/badge.svg

:target: https://codecov.io/gh/samuelcolvin/python-devtools

.. |pypi| image:: https://img.shields.io/pypi/v/python-devtools.svg

:target: https://pypi.python.org/pypi/python-devtools

from .debug import *

from .version import VERSION

import ast

import inspect

import re

import warnings

from pathlib import Path

from textwrap import dedent

from typing import Generator, List

__all__ = ['Debug', 'debug']

CWD = Path('.').resolve()

class DebugArgument:

__slots__ = 'value', 'name', 'extra'

def __init__(self, value, *, name=None, **extra):

self.value = value

self.name = name

self.extra = {k: v for k, v in extra.items() if v}

def value_str(self):

if isinstance(self.value, str):

return '"{}"'.format(self.value)

return str(self.value)

def __str__(self) -> str:

template = '{value} ({self.value.__class__.__name__}) {extra}'

if self.name:

template = '{self.name} = ' + template

return template.format(

self=self,

value=self.value_str(),

extra=' '.join('{}={}'.format(k, v) for k, v in self.extra.items())

).rstrip(' ') # trailing space if extra is empty

class DebugOutput:

"""

arg_class = DebugArgument

__slots__ = 'filename', 'lineno', 'frame', 'arguments'

def __init__(self, *, filename: str, lineno: int, frame: str, arguments: List[DebugArgument]):

self.filename = filename

self.lineno = lineno

self.frame = frame

self.arguments = arguments

def __str__(self) -> str:

template = '{s.filename}:{s.lineno} {s.frame}'

if len(self.arguments) == 1:

return (template + ': {a}').format(s=self, a=self.arguments[0])

else:

return (template + '\n {a}').format(s=self, a='\n '.join(str(a) for a in self.arguments))

def __repr__(self) -> str:

arguments = ' '.join(str(a) for a in self.arguments)

return '<DebugOutput {s.filename}:{s.lineno} {s.frame} arguments: {a}>'.format(s=self, a=arguments)

class Debug:

output_class = DebugOutput

def __call__(self, *args, **kwargs):

print(self._process(args, kwargs), flush=True)

def format(self, *args, **kwargs):

return self._process(args, kwargs)

def _process(self, args, kwargs):

curframe = inspect.currentframe()

frames = inspect.getouterframes(curframe, context=20)

# BEWARE: this must be call by a method which in turn is called "directly" for the frame to be correct

call_frame = frames[2]

filename = call_frame.filename

if filename.startswith('/'):

# make the path relative

try:

filename = str(Path(filename).relative_to(CWD))

except ValueError:

# happens if filename path is not within CWD

pass

call_lines = []

for line in range(call_frame.index, 0, -1):

new_line = call_frame.code_context[line]

call_lines.append(new_line)

if re.search('debug *\(', new_line):

break

call_lines.reverse()

return self.output_class(

filename=filename,

lineno=call_frame.lineno - len(call_lines),

frame=call_frame.function,

arguments=list(self._process_args(call_lines, args, kwargs))

)

def _process_args(self, call_lines, args, kwargs) -> Generator[DebugArgument, None, None]: # noqa: C901

code = dedent(''.join(call_lines))

func_ast = ast.parse(code).body[0].value

arg_offsets = list(self._get_offsets(func_ast))

for arg, ast_node, i in zip(args, func_ast.args, range(1000)):

if isinstance(ast_node, ast.Name):

yield self.output_class.arg_class(arg, name=ast_node.id)

elif isinstance(ast_node, ast.Str):

yield self.output_class.arg_class(arg, len=len(arg))

elif isinstance(ast_node, (ast.Num, ast.List, ast.Dict, ast.Set)):

yield self.output_class.arg_class(arg)

elif isinstance(ast_node, (ast.Call, ast.Compare)):

# TODO replace this hack with astor when it get's a new release

end = -2

try:

next_line, next_offset = arg_offsets[i + 1]

if next_line == ast_node.lineno:

end = next_offset

except IndexError:

pass

name = call_lines[ast_node.lineno - 1][ast_node.col_offset:end]

yield self.output_class.arg_class(arg, name=name.strip(' ,'))

else:

warnings.warn('Unknown type: {}'.format(ast.dump(ast_node)), category=RuntimeError)

yield self.output_class.arg_class(arg)

kw_arg_names = {}

for kw in func_ast.keywords:

if isinstance(kw.value, ast.Name):

kw_arg_names[kw.arg] = kw.value.id

for name, value in kwargs.items():

yield self.output_class.arg_class(value, name=name, variable=kw_arg_names.get(name))

@classmethod

def _get_offsets(cls, func_ast):

for arg in func_ast.args:

yield arg.lineno, arg.col_offset

for kw in func_ast.keywords:

yield kw.value.lineno, kw.value.col_offset - len(kw.arg) - 1

debug = Debug()

from distutils.version import StrictVersion

__all__ = ['VERSION']

VERSION = StrictVersion('0.0.1')

-r tests/requirements.txt

ipython # pyup: ignore