1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package ranger.fsobject</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.fsobject</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/fsobject/__init__.py">/home/hut/work/ranger/ranger/fsobject/__init__.py</a></font></td></tr></table>
<p><tt>FileSystemObjects are representation of files and directories<br>
with fast access to their properties through caching</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ranger.fsobject.directory.html">directory</a><br>
</td><td width="25%" valign=top><a href="ranger.fsobject.file.html">file</a><br>
</td><td width="25%" valign=top><a href="ranger.fsobject.fsobject.html">fsobject</a><br>
</td><td width="25%" valign=top><a href="ranger.fsobject.loader.html">loader</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="ranger.fsobject.html#NotLoadedYet">NotLoadedYet</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="NotLoadedYet">class <strong>NotLoadedYet</strong></a>(<a href="builtins.html#Exception">builtins.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="ranger.fsobject.html#NotLoadedYet">NotLoadedYet</a></dd>
<dd><a href="builtins.html#Exception">builtins.Exception</a></dd>
<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br>
<dl><dt><a name="NotLoadedYet-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f6a9223e120><dd><tt>T.<a href="#NotLoadedYet-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br>
<dl><dt><a name="NotLoadedYet-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="NotLoadedYet-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="NotLoadedYet-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotLoadedYet-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="NotLoadedYet-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="NotLoadedYet-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotLoadedYet-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NotLoadedYet-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="NotLoadedYet-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt><a href="builtins.html#Exception">Exception</a>.<a href="#NotLoadedYet-with_traceback">with_traceback</a>(tb) --<br>
set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br>
<dl><dt><strong>__cause__</strong></dt>
<dd><tt>exception cause</tt></dd>
</dl>
<dl><dt><strong>__context__</strong></dt>
<dd><tt>exception context</tt></dd>
</dl>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>__traceback__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
</td></tr></table></td></tr></table><<# This file is part of ranger, the console file manager.
# License: GNU GPL version 3, see the file "AUTHORS" for details.
NAME = ranger
VERSION = $(shell grep -m 1 -o '[0-9][0-9.]\+\S*' README.md)
NAME_RIFLE = rifle
VERSION_RIFLE = $(VERSION)
SNAPSHOT_NAME ?= $(NAME)-$(VERSION)-$(shell git rev-parse HEAD | cut -b 1-8).tar.gz
# Find suitable python version (need python >= 2.6 or 3.1):
PYTHON ?= $(shell \
(python -c 'import sys; sys.exit(sys.version < "2.6")' && \
which python) \
|| (which python3) \
|| (python2 -c 'import sys; sys.exit(sys.version < "2.6")' && \
which python2) \
)
ifeq ($(PYTHON),)
$(error No suitable python found.)
endif
SETUPOPTS ?= '--record=install_log.txt'
DOCDIR ?= doc/pydoc
DESTDIR ?= /
PYOPTIMIZE ?= 1
FILTER ?= .
CWD = $(shell pwd)
default: test compile
@echo 'Run `make options` for a list of all options'
options: help
@echo
@echo 'Options:'
@echo 'PYTHON = $(PYTHON)'
@echo 'PYOPTIMIZE = $(PYOPTIMIZE)'
@echo 'DOCDIR = $(DOCDIR)'
@echo 'DESTDIR = $(DESTDIR)'
help:
@echo 'make: Test and compile ranger.'
@echo 'make install: Install $(NAME)'
@echo 'make pypi_sdist: Release a new sdist to PyPI'
@echo 'make clean: Remove the compiled files (*.pyc, *.pyo)'
@echo 'make doc: Create the pydoc documentation'
@echo 'make cleandoc: Remove the pydoc documentation'
@echo 'make man: Compile the manpage with "pod2man"'
@echo 'make manhtml: Compile the html manpage with "pod2html"'
@echo 'make snapshot: Create a tar.gz of the current git revision'
@echo 'make test: Test everything'
@echo 'make test_pylint: Test using pylint'
@echo 'make test_flake8: Test using flake8'
@echo 'make test_doctest: Test using doctest'
@echo 'make test_pytest: Test using pytest'
@echo 'make todo: Look for TODO and XXX markers in the source code'
install:
$(PYTHON) setup.py install $(SETUPOPTS) \
'--root=$(DESTDIR)' --optimize=$(PYOPTIMIZE)
compile: clean
PYTHONOPTIMIZE=$(PYOPTIMIZE) $(PYTHON) -m compileall -q ranger
clean:
find ranger -regex .\*\.py[co]\$$ -delete
find ranger -depth -name __pycache__ -type d -exec rm -r -- {} \;
doc: cleandoc
mkdir -p $(DOCDIR)
cd $(DOCDIR); \
$(PYTHON) -c 'import pydoc, sys; \
sys.path[0] = "$(CWD)"; \
pydoc.writedocs("$(CWD)")'
find . -name \*.html -exec sed -i 's|'"$(CWD)"'|../..|g' -- {} \;
TEST_PATHS_MAIN = \
$(shell find ./ranger -mindepth 1 -maxdepth 1 -type d \
! -name '__pycache__' \
! -path './ranger/config' \
! -path './ranger/data' \
) \
./ranger/__init__.py \
$(shell find ./doc/tools ./examples -type f -name '*.py') \
./ranger.py \
./setup.py \
./tests
TEST_PATH_CONFIG = ./ranger/config
test_pylint:
@echo "Running pylint..."
pylint $(TEST_PATHS_MAIN)
pylint --rcfile=$(TEST_PATH_CONFIG)/.pylintrc $(TEST_PATH_CONFIG)
test_flake8:
@echo "Running flake8..."
flake8 $(TEST_PATHS_MAIN) $(TEST_PATH_CONFIG)
test_doctest:
@echo "Running doctests..."
@for FILE in $(shell grep -IHm 1 doctest -r ranger | grep $(FILTER) | cut -d: -f1); do \
echo "Testing $$FILE..."; \
RANGER_DOCTEST=1 PYTHONPATH=".:"$$PYTHONPATH ${PYTHON} $$FILE; \
done
test_pytest:
@echo "Running py.test tests..."
py.test tests
test_other:
@echo "Checking completeness of man page..."
@tests/manpage_completion_test.py
test: test_pylint test_flake8 test_doctest test_pytest test_other
@echo "Finished testing: All tests passed!"
man:
pod2man --stderr --center='ranger manual' --date='$(NAME)-$(VERSION)' \
--release=$(shell date +%x) doc/ranger.pod doc/ranger.1
pod2man --stderr --center='rifle manual' --date='$(NAME_RIFLE)-$(VERSION_RIFLE)' \
--release=$(shell date +%x) doc/rifle.pod doc/rifle.1
manhtml:
pod2html doc/ranger.pod --outfile=doc/ranger.1.html
cleandoc:
test -d $(DOCDIR) && rm -- $(DOCDIR)/*.html || true
snapshot:
git archive --prefix='$(NAME)-$(VERSION)/' --format=tar HEAD | gzip > $(SNAPSHOT_NAME)
dist: snapshot
todo:
@grep --color -Ion '\(TODO\|XXX\).*' -r ranger
.PHONY: clean cleandoc compile default dist doc help install man manhtml \
options snapshot test test_pylint test_flake8 test_doctest test_pytest \
test_other todo pypi_sdist
|