Merge pull request #14 from aipescience/dev

update to 0.6.0

Author: kimakan

.github/workflows/pytest.yml

@@ -0,0 +1,51 @@
+
+name: pytest
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+  
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install prerequisites
+        run: |
+          sudo apt update
+          sudo apt install -y default-jre
+          python -m pip install --upgrade pip
+          
+      - name: Build queryparser
+        run: |
+          wget http://www.antlr.org/download/antlr-4.11.1-complete.jar
+          make
+          pip install -r requirements.txt -I -e .
+          pip install pytest-cov
+          pip install coveralls
+          
+      - name: Run Tests
+        run: |
+          pytest lib/ --cov=queryparser
+          coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          
+          
+  coveralls:
+    name: Indicate completion to coveralls
+    needs: build
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+    - name: Run Coveralls finish
+      run: |
+        pip install coveralls
+        coveralls --service=github --finish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.travis.yml

@@ -0,0 +1,9 @@
+## 0.6.0 (2022-11-04)
+
+- bump the version of `antlr4-python3-runtime` to 4.11.1
+- added support for two custom functions - `gaia_healpix_index`, `pdist`
+- added support for `DISTINCT ON` , [Issue#11](https://github.com/aipescience/queryparser/issues/11)
+- added the `ILIKE` operator 
+- fix installation of requirements.txt (e.g., the required version of 
+antlr4-python3-runtime was overwritten by the most current one)
+

CHANGELOG.md

@@ -4,34 +4,26 @@ queryparser
 **Tool for parsing and processing of MySQL/PostgreSQL and translation of
 ADQL SELECT-like queries**
 
-Designed to be used in conjunction with `django-daiquri <http://github.com/aipescience/django-daiquiri/>`_
+Designed to be used in conjunction with [django-daiquri](https://github.com/django-daiquiri/daiquiri)
 as a query processing backend but it can be easily used as a stand-alone tool
 or integrated into another project.
 
-.. image:: https://travis-ci.org/aipescience/queryparser.svg?branch=master
-   :alt: Build Status
-   :target: https://travis-ci.org/aipescience/queryparser
 
-.. image:: https://coveralls.io/repos/github/aipescience/queryparser/badge.svg?branch=master
-   :alt: Coverage Status
-   :target: https://coveralls.io/github/aipescience/queryparser?branch=master
+[![pytest Workflow Status](https://github.com/aipescience/queryparser/actions/workflows/pytest.yml/badge.svg)](https://github.com/aipescience/queryparser/actions/workflows/pytest.yml)
+[![Coverage Status](https://coveralls.io/repos/aipescience/queryparser/badge.svg?branch=dev&service=github)](https://coveralls.io/github/aipescience/queryparser?branch=dev)
+[![License](http://img.shields.io/badge/license-APACHE-blue.svg?style=flat)](https://github.com/aipescience/queryparser/blob/master/LICENSE)
+[![Latest Version](https://img.shields.io/pypi/v/queryparser-python3.svg?style=flat)](https://pypi.org/project/queryparser-python3/)
 
-.. image:: https://img.shields.io/pypi/v/queryparser-python3.svg?style=flat
-   :alt: Latest Version
-   :target: https://pypi.python.org/pypi/queryparser-python3/
-
-.. image:: http://img.shields.io/badge/license-APACHE-blue.svg?style=flat
-    :target: https://github.com/adrn/schwimmbad/blob/master/LICENSE
 
 
 Installation
 ------------
 
 The easiest way to install the package is by using the pip tool:
 
-.. code-block:: shell
-
+```bash
     pip install queryparser-python3
+```
 
 Alternatively, you can clone the repository and install it from there.
 However, this step also requires generating the parser which is a slightly
@@ -41,21 +33,21 @@ more elaborate process (see below).
 Generating the parser from the git repository
 ---------------------------------------------
 
-To generate the parsers you need `python3` , `java` above version 
-7, and `antlr4` (`antlr-4.*-complete.jar` has to be installed inside the 
+To generate the parsers you need `python3` , `java` above version
+7, and `antlr4` (`antlr-4.*-complete.jar` has to be installed inside the
 `/usr/local/lib/` or `/usr/local/bin/` directories).
 
 After cloning the project run
 
-.. code-block:: bash
-
+```bash
     make
+```
 
 and a `lib` directory will be created. After that, run
 
-.. code-block:: bash
-
+```bash
     python setup.py install
+```
 
 to install the generated parser in your virtual environment.
 
@@ -66,24 +58,23 @@ Parsing MySQL and PostgreSQL
 Parsing and processing of MySQL queries can be done by creating an instance
 of the ``MySQLQueryProcessor`` class
 
-.. code-block:: python
-
+```python
     from queryparser.mysql import MySQLQueryProcessor
-
     qp = MySQLQueryProcessor()
+```
 
 feeding it a MySQL query
 
-.. code-block:: python
-
+```python
     sql = "SELECT a FROM db.tab;"
     qp.set_query(sql)
+```
 
 and running it with
 
-.. code-block:: python
-
+```python
     qp.process_query()
+```
 
 After the processing is completed, the processor object ``qp`` will include
 tables, columns, functions, and keywords used in the query or will raise a
@@ -94,11 +85,10 @@ Alternatively, passing the query at initialization automatically processes it.
 PostgreSQL parsing is very similar to MySQL, except it requires importing
 the `PostgreSQLProcessor` class:
 
-.. code-block:: python
-
+```python
     from queryparser.postgresql import PostgreSQLQueryProcessor
-
     qp = PostgreSQLQueryProcessor()
+```
 
 The rest of the functionality remains the same.
 
@@ -109,18 +99,17 @@ Translating ADQL
 Translation of ADQL queries is done similarly by first creating an instance of
 the ``ADQLQueryTranslator`` class
 
-.. code-block:: python
-
+```python
     from queryparser.adql import ADQLQueryTranslator
-
     adql = "SELECT TOP 100 POINT('ICRS', ra, de) FROM db.tab;"
     adt = ADQLQueryTranslator(adql)
+```
 
 and calling
 
-.. code-block:: python
-
+```python
     adt.to_mysql()
+```
 
 which returns a translated string representing a valid MySQL query if
 the ADQL query had no errors. The MySQL query can then be parsed with the
@@ -132,14 +121,14 @@ Testing
 
 First, install `pytest`
 
-.. code-block:: bash
-
+```bash
     pip install pytest
+```
 
 then run the test suite for a version of python you would like to test with
 
-.. code-block:: bash
-    
+```bash
     pytest lib/
+```
 
-More elaborate testing procedures can be found in the development notes. 
+More elaborate testing procedures can be found in the development notes.

README.rst README.mdREADME.rst renamed to README.md

@@ -0,0 +1,69 @@
+## ADQL
+#### Missing functions
+`CAST` function is not supported at all
+
+
+## PostgreSQL
+#### Missing functions 
+Functions that are supported in pg14 but are not processed py the queryparser
+
+###### Mathematical Functions
+ - `factorial`
+ - `gcd`
+ - `lcm`
+ - `log10`
+ - `min_scale`
+ - `truncate` is not supported in pg14 anymore!
+ - `trunc`
+ - `width_bucket`
+
+###### Random Functions
+ - `setseed` - not sure whether this functions must be implemented...
+
+###### Trigonometric Functions
+ - `acosd`
+ - `asind`
+ - `atand`
+ - `atan2d`
+ - `cosd`
+ - `cotd`
+ - `sind`
+ - `tand`
+
+###### Hyperbolic Functions
+ - `sinh`
+ - `cosh`
+ - `tanh`
+ - `asinh`
+ - `acosh`
+ - `atanh`
+
+###### SQL String Functions and Operators
+ - `||`, concatenates two strings, e.g. 'Post' || "greSQL" -> PostgreSQL, if 
+ one of the inputs is a non-string, then it's converted to string
+ - `IS [NOT] NORMALIZED`, see https://www.postgresql.org/docs/14/functions-string.html
+ - `character_length`, same as `char_length`
+ - `normalize`
+ - `octet_length`
+ - `overlay`
+ - `position`
+ - `trim`
+
+###### Other String Functions
+ - `btrim`
+ - `format`
+ - `initcap`
+ - `parse_ident`
+ - all `quote_*` functions were not implemented, although already present in pg9
+ - all `regex_*` functions were not implemented, although already present in pg9
+ - `split_part`
+ - `strpos`
+ - `starts_with`
+ - `string_to_array`
+ - `string_to_table`
+ - `to_ascii`
+ - `unistr`
+
+
+###### Binary String Functions and Operators
+ 

docs/dev-notes.md

@@ -6,7 +6,7 @@
 import subprocess
 import re
 
-ANTLR_JAR = 'antlr-4.8-complete.jar'
+ANTLR_JAR = 'antlr-4.11.1-complete.jar'
 ANTLR_DIRS = ('.', '/usr/local/lib/', '/usr/local/bin/')
 
 QUERYPARSER_SRC = 'src/queryparser/'

generate.py

@@ -1,3 +1,3 @@
-antlr4-python3-runtime==4.8
-pytest==5.4.3
-PyYAML==5.3.1
+antlr4-python3-runtime==4.11.1
+pytest~=6.2.5
+PyYAML~=6.0

requirements.txt

@@ -9,11 +9,8 @@
 with open('lib/queryparser/__init__.py') as f:
     metadata = dict(re.findall(r'__(.*)__ = [\']([^\']*)[\']', f.read()))
 
-requirements = [
-    'pytest',
-    'coverage',
-    'antlr4-python%d-runtime' % python_version
-]
+with open('requirements.txt') as f:
+    requirements = f.readlines()
 
 # work around for python 3.4 and antlr4-python3-runtime
 if sys.version_info.major == 3 and sys.version_info.minor < 5:
@@ -30,7 +27,7 @@
     url='https://github.com/aipescience/queryparser',
     description=u'Parses PostgreSQL/MySQL and translates ADQL to ' +\
             'PostgreSQL/MySQL.',
-    long_description=open('README.rst').read(),
+    long_description=open('README.md').read(),
     long_description_content_type='text/x-rst',
     install_requires=requirements,
     classifiers=[],

setup.py

@@ -1,9 +1,9 @@
 __title__ = 'queryparser'
-__version__ = '0.5.0'
+__version__ = '0.6.0'
 __author__ = 'Gal Matijevic'
 __email__ = 'gmatijevic@aip.de'
 __license__ = 'Apache-2.0'
-__copyright__ = 'Copyright 2016-2020 Leibniz Institute for Astrophysics' +\
+__copyright__ = 'Copyright 2016-2022 Leibniz Institute for Astrophysics' +\
         'Potsdam (AIP)'
 
 VERSION = __version__

src/queryparser/__init__.py

@@ -65,8 +65,8 @@ POINT               :P_ O_ I_ N_ T_ ;
 POLYGON             :P_ O_ L_ Y_ G_ O_ N_ ;
 POWER               :P_ O_ W_ E_ R_ ;
 RADIANS             :R_ A_ D_ I_ A_ N_ S_ ;
-REGION              :R_ E_ G_ I_ O_ N_ ;
 RAND                :R_ A_ N_ D_ ;
+REGION              :R_ E_ G_ I_ O_ N_ ;
 ROUND               :R_ O_ U_ N_ D_ ;
 SIN                 :S_ I_ N_ ;
 SQRT                :S_ Q_ R_ T_ ;
@@ -364,4 +364,4 @@ WS
    '\u2029' | '\u202f' | '\u205f' | '\u3000' )+ -> channel(HIDDEN)
 ;
 
-COMMENT: '--' ~( '\r' | '\n' )* -> skip ;
+COMMENT: '--' ~( '\r' | '\n' )* -> skip ;