From 166004565a4cc0a8720aa56a98d51a578982c76e Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 25 Feb 2012 00:52:43 +0100 Subject: [PATCH] Sphinx documentation tests --- __init__.py | 0 doc/Makefile | 153 +++++++++++++++++++++++++++++ doc/conf.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 22 +++++ doc/make.bat | 190 ++++++++++++++++++++++++++++++++++++ pyfuzzyparser.py | 176 ++++++++++++++++++++++++++++----- test.py | 29 ++++-- 7 files changed, 786 insertions(+), 30 deletions(-) create mode 100644 __init__.py create mode 100644 doc/Makefile create mode 100644 doc/conf.py create mode 100644 doc/index.rst create mode 100644 doc/make.bat diff --git a/__init__.py b/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..2d941b82 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/py_fuzzycompleter.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/py_fuzzycompleter.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/py_fuzzycompleter" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/py_fuzzycompleter" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 00000000..4308acd7 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,246 @@ +# -*- coding: utf-8 -*- +# +# py_fuzzycompleter documentation build configuration file, created by +# sphinx-quickstart on Sat Feb 25 00:07:04 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../..')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'py_fuzzycompleter' +copyright = u'2012, David Halter' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1' +# The full version, including alpha/beta/rc tags. +release = '0.1alpha' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'py_fuzzycompleterdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'py_fuzzycompleter.tex', u'py_fuzzycompleter Documentation', + u'David Halter', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'py_fuzzycompleter', u'py_fuzzycompleter Documentation', + [u'David Halter'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'py_fuzzycompleter', u'py_fuzzycompleter Documentation', + u'David Halter', 'py_fuzzycompleter', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 00000000..0335154c --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,22 @@ +.. py_fuzzycompleter documentation master file, created by + sphinx-quickstart on Sat Feb 25 00:07:04 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to py_fuzzycompleter's documentation! +============================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/make.bat b/doc/make.bat new file mode 100644 index 00000000..1597e3da --- /dev/null +++ b/doc/make.bat @@ -0,0 +1,190 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\py_fuzzycompleter.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\py_fuzzycompleter.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/pyfuzzyparser.py b/pyfuzzyparser.py index 356e532d..fc6ca4ad 100644 --- a/pyfuzzyparser.py +++ b/pyfuzzyparser.py @@ -1,5 +1,19 @@ """" TODO This is a parser + +scope + imports + subscopes + statements + +Ignored simple statements: + - print (no use for it) + - assert + - break, continue (because we avoid loops) + - del (also no used, since this script avoids loops and files) + - exec (dangerous - not controllable) + +global is a special case and will not be used here """ import sys import tokenize @@ -21,6 +35,7 @@ class Scope(object): self.subscopes = [] self.locals = [] self.imports = [] + self.statements = [] self.docstr = docstr self.parent = None self.name = name @@ -28,7 +43,8 @@ class Scope(object): self.line_nr = line_nr def add_scope(self, sub): - #print 'push scope: [%s@%s]' % (sub.name, sub.indent) + if sub == None: + print 'push scope: [%s@%s]' % (sub.name, sub.indent) sub.parent = self self.subscopes.append(sub) return sub @@ -61,6 +77,7 @@ class Scope(object): self.locals.remove(l) def get_code(self, first_indent=False, indention=" "): + """ Returns the code of the current scope. """ string = "" if len(self.docstr) > 0: string += '"""' + self.docstr + '"""\n' @@ -98,6 +115,31 @@ class Class(Scope): str += "pass\n" return str +class Flow(Scope): + """ + Used to describe programming structure - flow statements, + which indent code, but are not classes or functions: + - for + - while + - if + - try + - with + Therefore statements like else, except and finally are also here, + they are now saved in the root flow elements, but in the next variable. + """ + def __init__(self, code, functions, indent, line_nr): + super(Flow, self).__init__(name, indent, line_nr, None) + name = code + self.next = None + + def get_code(self, first_indent=False, indention=" "): + str = 'class %s' % (self.name) + str += ':\n' + str += super(Class, self).get_code(True, indention) + print "get_code class %s %i" % (self.name, self.is_empty()) + if self.is_empty(): + str += "pass\n" + return str class Function(Scope): def __init__(self, name, params, indent, line_nr, docstr=''): @@ -117,16 +159,23 @@ class Function(Scope): class Import(object): """ - stores the imports of any scopes - """ # TODO check star? + stores the imports of any scopes. + + >>> 1+1 + 2 + + :param line_nr: Line number. + :param namespace: the namespace which is imported. + :param alias: the alias (valid in the current namespace). + :param from_ns: from declaration in an import. + :param star: if a star is used -> from time import *. + + :returns: test + :raises: + + TODO check star? + """ def __init__(self, line_nr, namespace, alias='', from_ns='', star=False): - """ - @param line_nr - @param namespace: the namespace which is imported - @param alias: the alias (valid in the current namespace) - @param from_ns: from declaration in an import - @param star: if a star is used -> from time import * - """ self.line_nr = line_nr self.namespace = namespace self.alias = alias @@ -147,14 +196,14 @@ class Import(object): class Statement(object): - """ This is the super class for Local and Functions """ - def __init__(self, line_nr, stmt): + """ This is the class for Local and Functions """ + def __init__(self, code, locals, functions): """ @param line_nr @param stmt the statement string """ self.line_nr = line_nr - self. stmt = stmt + self.stmt = stmt def get_code(self): raise NotImplementedError() @@ -189,6 +238,22 @@ class Local(object): return "test import " + ns_str +class Name(object): + """ + Used to define names in python. + Which means the whole namespace/class/function stuff. + So a name like "module.class.function" + would result in an array of [module, class, function] + """ + def __init__(self, names): + super(Name, self).__init__() + self.names = names + + def get_code(self): + """ returns the name again in a full string format """ + return ".".join(names) + + class PyFuzzyParser(object): """ This class is used to parse a Python file, it then divides them into a @@ -198,16 +263,16 @@ class PyFuzzyParser(object): self.top = Scope('global', 0, 0) self.scope = self.top - def _parsedotname(self, pre=None): - #returns (dottedname, nexttoken) - name = [] - if pre is None: + def _parsedotname(self, pre_used_token=None): + """ @return (dottedname, nexttoken) """ + names = [] + if pre_used_token is None: tokentype, tok, indent = self.next() if tokentype != tokenize.NAME and tok != '*': - return ('', tok) + return ([], tok) else: - tok = pre - name.append(tok) + tok = pre_used_token + names.append(tok) while True: tokentype, tok, indent = self.next() if tok != '.': @@ -215,8 +280,29 @@ class PyFuzzyParser(object): tokentype, tok, indent = self.next() if tokentype != tokenize.NAME: break - name.append(tok) - return (".".join(name), tok) + names.append(tok) + return (names, tok) + + + def _parse_value_list(self, pre_used_token=None): + """ + A value list is a comma separated list. This is used for: + >>> for a,b,self.c in enumerate(test) + """ + value_list = [] + if pre_used_token: + n = self._parsedotname(pre_used_token) + if n: + value_list.append(n) + + tokentype, tok, indent = self.next() + while tok != 'in' or tokentype == tokenize.NEWLINE: + n = self._parsedotname(tok) + if n: + value_list.append(n) + + tokentype, tok, indent = self.next() + return (value_list, tok) def _parseimportlist(self): imports = [] @@ -260,6 +346,7 @@ class PyFuzzyParser(object): name += "%s " % str(tok) return names + def _parsefunction(self, indent): tokentype, fname, ind = self.next() if tokentype != tokenize.NAME: @@ -276,6 +363,7 @@ class PyFuzzyParser(object): return Function(fname, params, indent, self.line_nr) + def _parseclass(self, indent): tokentype, cname, ind = self.next() if tokentype != tokenize.NAME: @@ -290,6 +378,7 @@ class PyFuzzyParser(object): return Class(cname, super, indent, self.line_nr) + def _parseassignment(self): assign = '' tokentype, tok, indent = self.next() @@ -326,6 +415,29 @@ class PyFuzzyParser(object): assign += tok return "%s" % assign + + def _parse_words(self, word): + """ + Used to parse a word, if the tokenizer returned a word at the start of + a new command. + """ + return + + + def _parse_statement(self, tok = None): + """ + Parses statements like: + >>> a = test(b) + >>> a += 3 - 2 or b + and so on. One row at a time. + """ + string = tok + tok = True + while tok: + tokentype, tok, indent = self.next() + string += tok + return string + def next(self): type, tok, position, dummy, self.parserline = self.gen.next() (self.line_nr, indent) = position @@ -350,7 +462,7 @@ class PyFuzzyParser(object): if func is None: print "function: syntax error..." continue - dbg("new scope: function") + dbg("new scope: function %s" % (func.name)) freshscope = True self.scope = self.scope.add_scope(func) elif tok == 'class': @@ -359,8 +471,9 @@ class PyFuzzyParser(object): print "class: syntax error..." continue freshscope = True - dbg("new scope: class") + dbg("new scope: class %s" % (cls.name)) self.scope = self.scope.add_scope(cls) + # import stuff elif tok == 'import': imports = self._parseimportlist() for mod, alias in imports: @@ -376,6 +489,16 @@ class PyFuzzyParser(object): i = Import(self.line_nr, name, alias, mod) self.scope.add_import(i) freshscope = False + #loops + elif tok == 'for': + value_list, tok = self._parse_value_list() + if tok == 'in': + statement, tok = self._parse_statement() + if tok == ':': + self.scope.append(statement) + + elif tok == 'while': + param_list = self._parse_while_loop() elif tokentype == tokenize.STRING: if freshscope: self.scope.doc(tok) @@ -386,7 +509,12 @@ class PyFuzzyParser(object): dbg("parseassignment: %s = %s" % (name, stmt)) if stmt != None: self.scope.add_local("%s = %s" % (name, stmt)) + else: + #print "_not_implemented_", tok, self.parserline + pass freshscope = False + #else: + #print "_not_implemented_", tok, self.parserline except StopIteration: # thrown on EOF pass #except: diff --git a/test.py b/test.py index 156ea920..57611c52 100644 --- a/test.py +++ b/test.py @@ -46,11 +46,28 @@ def func(): cdef = A() return test - -for i in range(3): - asdf = aaa - print 'blub' +#for i in range(3): +# asdf = aaa +# print 'blub' -datetime. -A. +def ass_test(a): + """docstring for assignment test""" + a -= 1 + b, c, d = (1,2,3) + del b + return (a+b)*2 + + +matrix = [[1,2,3], [4,5,6], [7,8,9]] +def loop_test(a): + """docstring for loop_test""" + global matrix + for i in matrix: + print a + #while 1: + # del a + # print a + + return Matrix[0,1] +