Commits

Kirill Simonov committed e2609e2

Updated API documentation.

Comments (0)

Files changed (4)

 .. autoclass:: DBVal
 
 
+:mod:`htsql.mark`
+-----------------
+
+.. automodule:: htsql.mark
+
+.. autoclass:: Mark
+   :members: union, pointer
+
+
+:mod:`htsql.error`
+------------------
+
+.. automodule:: htsql.error
+
+.. autoclass:: HTTPError
+   :members: __call__
+
+Generic HTTP errors
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: BadRequestError
+
+.. autoclass:: ForbiddenError
+
+.. autoclass:: NotFoundError
+
+.. autoclass:: ConflictError
+
+.. autoclass:: InternalServerError
+
+.. autoclass:: NotImplementedError
+
+Concrete HTSQL Errors
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: InvalidSyntaxError
+
+
+:mod:`htsql.application`
+------------------------
+
+.. automodule:: htsql.application
+
+.. autoclass:: Application
+   :members: __call__
+
+
+:mod:`htsql.tr`
+---------------
+
+.. automodule:: htsql.tr
+
+
+:mod:`htsql.tr.token`
+---------------------
+
+.. automodule:: htsql.tr.token
+
+.. autoclass:: Token
+   :members: unquote, quote
+
+.. autoclass:: SpaceToken
+
+.. autoclass:: NameToken
+
+.. autoclass:: StringToken
+
+.. autoclass:: NumberToken
+
+.. autoclass:: SymbolToken
+
+.. autoclass:: EndToken
+
+
+:mod:`htsql.tr.scanner`
+-----------------------
+
+.. automodule:: htsql.tr.scanner
+
+.. autoclass:: TokenStream
+   :members: peek, pop
+
+.. autoclass:: Scanner
+   :members: scan
+
+
+:mod:`htsql.tr.syntax`
+----------------------
+
+.. automodule:: htsql.tr.syntax
+
+.. autoclass:: Syntax
+   :members: __str__
+
+.. autoclass:: QuerySyntax
+
+.. autoclass:: SegmentSyntax
+
+.. autoclass:: FormatSyntax
+
+.. autoclass:: SelectorSyntax
+
+.. autoclass:: SieveSyntax
+
+.. autoclass:: OperatorSyntax
+
+.. autoclass:: FunctionOperatorSyntax
+
+.. autoclass:: FunctionCallSyntax
+
+.. autoclass:: GroupSyntax
+
+.. autoclass:: SpecifierSyntax
+
+.. autoclass:: IdentifierSyntax
+
+.. autoclass:: WildcardSyntax
+
+.. autoclass:: LiteralSyntax
+
+.. autoclass:: StringSyntax
+
+.. autoclass:: NumberSyntax
+
+
+:mod:`htsql.tr.parser`
+----------------------
+
+.. automodule:: htsql.tr.parser
+
+.. autoclass:: Parser
+   :members: parse, process
+
+.. autoclass:: QueryParser
+
+.. autoclass:: ElementParser
+
+.. autoclass:: TestParser
+
+.. autoclass:: AndTestParser
+
+.. autoclass:: ImpliesTestParser
+
+.. autoclass:: UnaryTestParser
+
+.. autoclass:: ComparisonParser
+
+.. autoclass:: ExpressionParser
+
+.. autoclass:: TermParser
+
+.. autoclass:: FactorParser
+
+.. autoclass:: PowerParser
+
+.. autoclass:: SieveParser
+
+.. autoclass:: SpecifierParser
+
+.. autoclass:: AtomParser
+
+.. autoclass:: GroupParser
+
+.. autoclass:: SelectorParser
+
+.. autoclass:: IdentifierParser
+
+
 :mod:`htsql.ctl`
 ----------------
 
    :members: get_help, get_intro, get_usage
 
 
+:mod:`htsql.ctl.regress`
+------------------------
+
+.. automodule:: htsql.ctl.regress
+
+.. autoclass:: TermStringIO
+
+.. autoclass:: Field(attribute, validator, default=MANDATORY_FIELD, hint=None)
+   :members: get_hint, get_signature
+
+.. autoclass:: AnyField
+
+.. autoclass:: TestData
+   :members: init_attributes
+
+.. autoclass:: TestCase
+   :members: get_hint, get_help, get_suites, matches,
+             ask, ask_halt, ask_record, ask_save,
+             out, out_exception, out_sep, out_header,
+             halted, failed, updated, passed,
+             verify, train
+
+.. autoclass:: RunAndCompareTestCase
+   :members: out_lines, out_diff, render, execute, differs
+
+.. autoclass:: SkipTestCase
+
+.. autoclass:: AppTestCase
+
+.. autoclass:: IncludeTestCase
+
+.. autoclass:: SuiteTestCase
+
+.. autoclass:: QueryTestCase
+
+.. autoclass:: CtlTestCase
+
+.. autoclass:: Fork
+   :members: start, end
+
+.. autoclass:: StartCtlTestCase
+
+.. autoclass:: EndCtlTestCase
+
+.. autoclass:: PythonCodeTestCase
+
+.. autoclass:: SQLTestCase
+
+.. autoclass:: SQLIncludeTestCase
+
+.. autoclass:: WriteToFileTestCase
+
+.. autoclass:: ReadFromFileTestCase
+
+.. autoclass:: RemoveFilesTestCase
+
+.. autoclass:: MakeDirTestCase
+
+.. autoclass:: RemoveDirTestCase
+
+.. autoclass:: TestState
+   :members: clone, merge
+
+.. autoclass:: RegressYAMLLoader
+   :members: load
+
+.. autoclass:: RegressYAMLDumper
+   :members: dump
+
+.. autoclass:: RegressRoutine
+   :members: get_help, get_feature
+
+

src/htsql/ctl/regress.py

 
 
 class ReadFromFileTestCase(RunAndCompareTestCase):
+    """
+    Reads the file content.
+    """
 
     name = "read-from-file"
     hint = """read the content of a file"""

src/htsql/error.py

 
 
 #
-# HTTP Errors.
+# Generic HTTP Errors.
 #
 
 

src/htsql/tr/parser.py

 
         This function does not have to exhaust the token stream.
 
-        `tokens` (:class:`htsql.scanner.TokenStream`)
+        The ``<<`` operator could be used as a synonym for :meth:`process`;
+        the following expressions are equivalent::
+
+            Parser << tokens
+            Parser.process(tokens)
+
+        `tokens` (:class:`htsql.tr.scanner.TokenStream`)
             The stream of tokens to parse.
         """
         # Override in subclasses.