opensipscli 0.3.5__tar.gz → 0.4.0__tar.gz

{opensipscli-0.3.5 → opensipscli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opensipscli
-Version: 0.3.5
+Version: 0.4.0
 Summary: OpenSIPS Command Line Interface
 Project-URL: Homepage, https://github.com/OpenSIPS/opensips-cli
 Project-URL: Source, https://github.com/OpenSIPS/opensips-cli
@@ -14,10 +14,9 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
-Requires-Dist: mysqlclient<1.4.0rc1
 Requires-Dist: opensips
-Requires-Dist: sqlalchemy-utils
-Requires-Dist: sqlalchemy<2,>=1.3.3
+Requires-Dist: pymysql
+Requires-Dist: sqlalchemy>=1.3.16
 Description-Content-Type: text/markdown
 
 # OpenSIPS CLI (Command Line Interface)
@@ -92,7 +91,7 @@ The OpenSIPSCLI object can receive a set of arguments/modifiers through the
 ```
 from opensipscli import args
 ...
-args = OpenSIPSCLIArgs(debug=True)
+args = args.OpenSIPSCLIArgs(debug=True)
 opensipscli = cli.OpenSIPSCLI(args)
 ...
 ```
@@ -100,7 +99,7 @@ opensipscli = cli.OpenSIPSCLI(args)
 Custom settings can be provided through the arguments, i.e.:
 ```
 # run commands over http
-args = OpenSIPSCLIArgs(communication_type = "http",
+args = args.OpenSIPSCLIArgs(communication_type = "http",
                        url="http://127.0.0.1:8080/mi")
 ...
 ```

{opensipscli-0.3.5 → opensipscli-0.4.0}/README.md

@@ -70,7 +70,7 @@ The OpenSIPSCLI object can receive a set of arguments/modifiers through the
 ```
 from opensipscli import args
 ...
-args = OpenSIPSCLIArgs(debug=True)
+args = args.OpenSIPSCLIArgs(debug=True)
 opensipscli = cli.OpenSIPSCLI(args)
 ...
 ```
@@ -78,7 +78,7 @@ opensipscli = cli.OpenSIPSCLI(args)
 Custom settings can be provided through the arguments, i.e.:
 ```
 # run commands over http
-args = OpenSIPSCLIArgs(communication_type = "http",
+args = args.OpenSIPSCLIArgs(communication_type = "http",
                        url="http://127.0.0.1:8080/mi")
 ...
 ```

{opensipscli-0.3.5 → opensipscli-0.4.0}/bin/opensips-cli

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 from opensipscli import main
 

{opensipscli-0.3.5 → opensipscli-0.4.0}/docker/Dockerfile

@@ -8,7 +8,7 @@ ENV DEBIAN_FRONTEND noninteractive
 
 #install basic components
 RUN apt-get -y update -qq && \
-    apt-get -y install git default-libmysqlclient-dev gcc
+    apt-get -y install git
 
 #add keyserver, repository
 RUN git clone https://github.com/OpenSIPS/opensips-cli.git /usr/src/opensips-cli && \
@@ -16,7 +16,7 @@ RUN git clone https://github.com/OpenSIPS/opensips-cli.git /usr/src/opensips-cli
     python3 -m pip install . && \
     cd / && rm -rf /usr/src/opensips-cli
 
-RUN apt-get purge -y git gcc && \
+RUN apt-get purge -y git && \
     apt-get autoremove -y && \
     apt-get clean
 

{opensipscli-0.3.5 → opensipscli-0.4.0}/docs/INSTALLATION.md

@@ -56,27 +56,26 @@ will vary on every supported operating system.
 
 ```
 # required OS packages
-sudo apt install python3 python3-pip python3-dev gcc default-libmysqlclient-dev \
-                 python3-mysqldb python3-sqlalchemy python3-sqlalchemy-utils \
+sudo apt install python3 python3-pip python3-pymysql python3-sqlalchemy \
                  python3-openssl
 
 # alternatively, you can build the requirements from source
-sudo pip3 install mysqlclient sqlalchemy sqlalchemy-utils pyOpenSSL
+sudo pip3 install PyMySQL sqlalchemy pyOpenSSL
 ```
 
 #### Red Hat / CentOS
 
 ```
 # required CentOS 7 packages
-sudo yum install python36 python36-pip python36-devel gcc mysql-devel \
-                 python36-mysql python36-sqlalchemy python36-pyOpenSSL
+sudo yum install python36 python36-pip python36-PyMySQL \
+                 python36-sqlalchemy python36-pyOpenSSL
 
 # required CentOS 8 packages
-sudo yum install python3 python3-pip python3-devel gcc mysql-devel \
-                 python3-mysqlclient python3-sqlalchemy python3-pyOpenSSL
+sudo yum install python3 python3-pip python3-PyMySQL \
+                 python3-sqlalchemy python3-pyOpenSSL
 
 # alternatively, you can build the requirements from source
-sudo pip3 install mysqlclient sqlalchemy sqlalchemy-utils pyOpenSSL
+sudo pip3 install PyMySQL sqlalchemy pyOpenSSL
 ```
 
 ### Download, Build & Install

{opensipscli-0.3.5 → opensipscli-0.4.0}/docs/modules/database.md

@@ -132,8 +132,10 @@ opensips-cli -o database_schema_path=~/src/opensips-3.1/scripts \
 
 ## Dependencies
 
-* [sqlalchemy and sqlalchemy_utils](https://www.sqlalchemy.org/) - used to
-abstract the SQL database regardless of the backend used
+* [sqlalchemy](https://www.sqlalchemy.org/) - used to abstract the SQL
+database regardless of the backend used
+* [PyMySQL](https://github.com/PyMySQL/PyMySQL) - pure-Python MySQL/MariaDB
+driver used by SQLAlchemy when connecting to MySQL backends
 
 ## Limitations
 

{opensipscli-0.3.5 → opensipscli-0.4.0}/docs/modules/user.md

@@ -53,8 +53,8 @@ opensips-cli -x user delete username@domain.com
 
 ## Dependencies
 
-* [sqlalchemy and sqlalchemy_utils](https://www.sqlalchemy.org/) - used to
-abstract the database manipulation, regardless of the backend used
+* [sqlalchemy](https://www.sqlalchemy.org/) - used to abstract the database
+manipulation, regardless of the backend used
 
 ## Limitations
 

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/args.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/cli.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).
@@ -195,6 +195,7 @@ class OpenSIPSCLI(cmd.Cmd, object):
         """
         preload a history file
         """
+        self.configure_completion_delims()
         history_file = cfg.get('history_file')
         logger.debug("using history file {}".format(history_file))
         try:
@@ -210,6 +211,14 @@ class OpenSIPSCLI(cmd.Cmd, object):
         if not self.registered_atexit:
             atexit.register(self.history_write)
 
+    def configure_completion_delims(self):
+        """
+        keep ':' inside tokens for command completion (e.g. "mi evi:")
+        """
+        delims = readline.get_completer_delims()
+        if ':' in delims:
+            readline.set_completer_delims(delims.replace(':', ''))
+
     def postcmd(self, stop, line):
         """
         post command after switching instance

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/comm.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/config.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/db.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).
@@ -23,8 +23,12 @@ import re
 
 try:
     import sqlalchemy
-    from sqlalchemy.ext.declarative import declarative_base
-    from sqlalchemy import Column, Date, Integer, String, Boolean
+    from sqlalchemy import Column, Date, Integer, String, Boolean, text
+    try:
+        from sqlalchemy.orm import declarative_base  # SA 1.4+
+    except ImportError:
+        # keep this for Debian Bullseye, which still has SA 1.3 in stable
+        from sqlalchemy.ext.declarative import declarative_base  # SA 1.3
     from sqlalchemy.orm import sessionmaker, deferred
 
     # for now, we use our own make_url(), since Alchemy API is highly unstable
@@ -32,13 +36,14 @@ try:
     #from sqlalchemy.engine.url import make_url
 
     sqlalchemy_available = True
-    logger.debug("SQLAlchemy version: ", sqlalchemy.__version__)
-    try:
-        import sqlalchemy_utils
-    except ImportError:
-        logger.debug("using embedded implementation of SQLAlchemy_Utils")
-        # copied from SQLAlchemy_utils repository
-        from opensipscli.libs import sqlalchemy_utils
+    logger.debug("SQLAlchemy version: %s", sqlalchemy.__version__)
+    # always use the vendored shim — the system sqlalchemy-utils package
+    # varies a lot across distros (0.36.x ships broken database_exists for
+    # PostgreSQL on Bullseye; 0.41.x is required for SA 2.0); the shim is
+    # tested against SA 1.3–2.0 and behaves consistently
+    from opensipscli.libs import sqlalchemy_utils
+    import pymysql
+    pymysql.install_as_MySQLdb()
 except ImportError:
     logger.info("sqlalchemy not available!")
     sqlalchemy_available = False
@@ -205,14 +210,10 @@ class osdb(object):
 
 	    # TODO: do this only for SQLAlchemy
         try:
-            if self.dialect == "postgresql":
-                self.__engine = sqlalchemy.create_engine(db_url, isolation_level='AUTOCOMMIT')
-            else:
-                self.__engine = sqlalchemy.create_engine(db_url)
+            self.__engine = sqlalchemy.create_engine(db_url, isolation_level='AUTOCOMMIT')
 
             logger.debug("connecting to %s", db_url)
-            self.__conn = self.__engine.connect().\
-                    execution_options(autocommit=True)
+            self.__conn = self.__engine.connect()
             # connect the Session object to our engine
             self.Session.configure(bind=self.__engine)
             # instantiate the Session object
@@ -266,7 +267,7 @@ class osdb(object):
             msg += " and password '********'"
         msg += " on database '{}'".format(self.db_name)
         try:
-            result = self.__conn.execute(sqlcmd)
+            result = self.__conn.execute(text(sqlcmd))
             if result:
                 logger.info( "{} was successful".format(msg))
         except:
@@ -296,7 +297,7 @@ class osdb(object):
                     self.session = self.Session()
                     logger.debug("connected to database URL '%s'", self.db_url)
             elif self.dialect != "sqlite":
-                self.__conn.execute("USE {}".format(self.db_name))
+                self.__conn.execute(text("USE {}".format(self.db_name)))
         except Exception as e:
             logger.error("failed to connect to %s", self.db_url)
             logger.error(e)
@@ -319,15 +320,13 @@ class osdb(object):
 
         # all good - it's time to create the database
         if self.dialect == "postgresql":
-            self.__conn.connection.connection.set_isolation_level(0)
             try:
-                self.__conn.execute("CREATE DATABASE {}".format(self.db_name))
-                self.__conn.connection.connection.set_isolation_level(1)
+                self.__conn.execute(text("CREATE DATABASE {}".format(self.db_name)))
             except sqlalchemy.exc.OperationalError as se:
                 logger.error("cannot create database: {}!".format(se))
                 return False
         elif self.dialect != "sqlite":
-            self.__conn.execute("CREATE DATABASE {}".format(self.db_name))
+            self.__conn.execute(text("CREATE DATABASE {}".format(self.db_name)))
 
         logger.debug("success")
         return True
@@ -344,11 +343,11 @@ class osdb(object):
             logger.error("database URL does not include a password")
             return False
 
-        if url.drivername.lower() == "mysql":
+        if url.drivername.lower().split('+')[0] == "mysql":
             sqlcmd = "CREATE USER IF NOT EXISTS '{}' IDENTIFIED BY '{}'".format(
                         url.username, url.password)
             try:
-                result = self.__conn.execute(sqlcmd)
+                result = self.__conn.execute(text(sqlcmd))
                 if result:
                     logger.info("created user '%s'", url.username)
             except:
@@ -368,7 +367,7 @@ class osdb(object):
                 sqlcmd = "SET PASSWORD FOR '{}' = PASSWORD('{}')".format(
                             url.username, url.password)
                 try:
-                    result = self.__conn.execute(sqlcmd)
+                    result = self.__conn.execute(text(sqlcmd))
                     if result:
                         logger.info("set password '%s%s%s' for '%s' (MariaDB)",
                             url.password[0] if len(url.password) >= 1 else '',
@@ -381,7 +380,7 @@ class osdb(object):
                             # syntax error!  OK, now try Oracle MySQL syntax
                             sqlcmd = "ALTER USER '{}' IDENTIFIED BY '{}'".format(
                                         url.username, url.password)
-                            result = self.__conn.execute(sqlcmd)
+                            result = self.__conn.execute(text(sqlcmd))
                             if result:
                                 logger.info("set password '%s%s%s' for '%s' (MySQL)",
                                     url.password[0] if len(url.password) >= 1 else '',
@@ -397,7 +396,7 @@ class osdb(object):
 
             sqlcmd = "GRANT ALL ON {}.* TO '{}'".format(self.db_name, url.username)
             try:
-                result = self.__conn.execute(sqlcmd)
+                result = self.__conn.execute(text(sqlcmd))
                 if result:
                     logger.info("granted access to user '%s' on DB '%s'",
                                 url.username, self.db_name)
@@ -408,13 +407,13 @@ class osdb(object):
 
             sqlcmd = "FLUSH PRIVILEGES"
             try:
-                result = self.__conn.execute(sqlcmd)
+                result = self.__conn.execute(text(sqlcmd))
                 logger.info("flushed privileges")
             except:
                 logger.exception("failed to flush privileges")
                 return False
 
-        elif url.drivername.lower() == "postgresql":
+        elif url.drivername.lower().split('+')[0] == "postgresql":
             if not self.exists_role(url.username):
                 logger.info("creating role %s", url.username)
                 if not self.create_role(url.username, url.password):
@@ -427,7 +426,7 @@ class osdb(object):
             logger.info(sqlcmd)
 
             try:
-                result = self.__conn.execute(sqlcmd)
+                result = self.__conn.execute(text(sqlcmd))
                 if result:
                     logger.debug("... OK")
             except:
@@ -459,7 +458,7 @@ class osdb(object):
         logger.info(sqlcmd)
 
         try:
-            result = self.__conn.execute(sqlcmd)
+            result = self.__conn.execute(text(sqlcmd))
             if result:
                 logger.info("role '{}' with options '{}' created".
                     format(role_name, role_options))
@@ -481,7 +480,7 @@ class osdb(object):
         where_str = self.get_where(filter_keys)
         statement = "DELETE FROM {}{}".format(table, where_str)
         try:
-            self.__conn.execute(statement)
+            self.__conn.execute(text(statement))
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -535,7 +534,7 @@ class osdb(object):
 
         sqlcmd = "DROP ROLE IF EXISTS {}".format(role_name)
         try:
-            result = self.__conn.execute(sqlcmd)
+            result = self.__conn.execute(text(sqlcmd))
             if result:
                 logger.debug("Role '%s' dropped", role_name)
         except:
@@ -572,7 +571,7 @@ class osdb(object):
                     # DROP/CREATE PROCEDURE statements seem to only work separately
                     sql = re.sub(r'DROP PROCEDURE .*\n', '', sql)
 
-                    self.__conn.execute(sql)
+                    self.__conn.execute(text(sql))
                 except sqlalchemy.exc.IntegrityError as ie:
                     raise osdbError("cannot deploy {} file: {}".
                             format(sql_file, ie)) from None
@@ -582,7 +581,7 @@ class osdb(object):
                     if not sql:
                         continue
                     try:
-                        self.__conn.execute(sql)
+                        self.__conn.execute(text(sql))
                     except sqlalchemy.exc.IntegrityError as ie:
                         raise osdbModuleAlreadyExistsError(
                             "cannot deploy {} file: {}".format(sql_file, ie)) from None
@@ -665,7 +664,7 @@ class osdb(object):
                 table,
                 where_str)
         try:
-            result = self.__conn.execute(statement)
+            result = self.__conn.execute(text(statement))
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -676,7 +675,7 @@ class osdb(object):
         """
         extract database dialect from an url
         """
-        return url.split('://')[0]
+        return url.split('://')[0].split('+')[0]
 
     def get_where(self, filter_keys):
         """
@@ -738,7 +737,7 @@ class osdb(object):
         logger.info(sqlcmd)
 
         try:
-            self.__conn.execute(sqlcmd)
+            self.__conn.execute(text(sqlcmd))
         except Exception as e:
             logger.exception(e)
             logger.error("failed to grant '%s' '%s' to '%s'", privs, on_statement, role_name)
@@ -767,6 +766,11 @@ class osdb(object):
             sqlalchemy.create_engine('{}://'.format(dialect))
         except sqlalchemy.exc.NoSuchModuleError:
             return False
+        except Exception:
+            # dialect is known to SQLAlchemy but its default DBAPI is not
+            # installed (e.g. MySQLdb when only PyMySQL is available);
+            # a compatible driver is still usable via the +driver URL syntax
+            pass
         return True
 
     def insert(self, table, keys):
@@ -781,14 +785,14 @@ class osdb(object):
         for v in keys.values():
             values += ", "
             if type(v) == int:
-                values += v
+                values += str(v)
             else:
                 values += "'{}'".format(
                         v.translate(str.maketrans({'\'': '\\\''})))
         statement = "INSERT INTO {} ({}) VALUES ({})".format(
                 table, ", ".join(keys.keys()), values[2:])
         try:
-            result = self.__conn.execute(statement)
+            result = self.__conn.execute(text(statement))
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -873,7 +877,7 @@ class osdb(object):
         for k, v in update_keys.items():
             update_str += ", {} = ".format(k)
             if type(v) == int:
-                update_str += v
+                update_str += str(v)
             else:
                 update_str += "'{}'".format(
                         v.translate(str.maketrans({'\'': '\\\''})))
@@ -881,7 +885,7 @@ class osdb(object):
         statement = "UPDATE {} SET {}{}".format(table,
                 update_str[2:], where_str)
         try:
-            result = self.__conn.execute(statement)
+            result = self.__conn.execute(text(statement))
         except sqlalchemy.exc.SQLAlchemyError as ex:
             logger.error("cannot execute query: {}".format(statement))
             logger.error(ex)
@@ -961,8 +965,8 @@ class osdb(object):
 
     @staticmethod
     def get_url_driver(url, capitalize=False):
+        driver = make_url(url).drivername.lower().split('+')[0]
         if capitalize:
-            driver = make_url(url).drivername.lower()
             capitalized = {
                 'mysql': 'MySQL',
                 'postgresql': 'PostgreSQL',
@@ -971,7 +975,7 @@ class osdb(object):
                 }
             return capitalized.get(driver, driver.capitalize())
         else:
-            return make_url(url).drivername.lower()
+            return driver
 
 
     @staticmethod

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/defaults.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).

{opensipscli-0.3.5 → opensipscli-0.4.0}/opensipscli/libs/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 ##
 ## This file is part of OpenSIPS CLI
 ## (see https://github.com/OpenSIPS/opensips-cli).