- improve imports

- documentation updates

README.md

@@ -12,6 +12,7 @@ from infi.clickhouse_orm.database import Database
 from infi.clickhouse_orm.models import Model
 from infi.clickhouse_orm.fields import *
 from infi.clickhouse_orm.engines import Memory
+from infi.clickhouse_orm.funcs import F
 
 class CPUStats(Model):
 
@@ -45,13 +46,13 @@ Querying the table is easy, using either the query builder or raw SQL:
 
 ```python
 # Calculate what percentage of the time CPU 1 was over 95% busy
-total = CPUStats.objects_in(db).filter(cpu_id=1).count()
-busy = CPUStats.objects_in(db).filter(cpu_id=1, cpu_percent__gt=95).count()
-print 'CPU 1 was busy {:.2f}% of the time'.format(busy * 100.0 / total)
+total = CPUStats.objects_in(db).filter(CPUStats.cpu_id == 1).count()
+busy = CPUStats.objects_in(db).filter(CPUStats.cpu_id == 1, CPUStats.cpu_percent > 95).count()
+print('CPU 1 was busy {:.2f}% of the time'.format(busy * 100.0 / total))
 
 # Calculate the average usage per CPU
-for row in CPUStats.objects_in(db).aggregate('cpu_id', average='avg(cpu_percent)'):
-    print 'CPU {row.cpu_id}: {row.average:.2f}%'.format(row=row)
+for row in CPUStats.objects_in(db).aggregate(CPUStats.cpu_id, average=F.avg(CPUStats.cpu_percent)):
+    print('CPU {row.cpu_id}: {row.average:.2f}%'.format(row=row))
 ```
 
-To learn more please visit the [documentation](docs/toc.md).
+To learn more please visit the [documentation](docs/toc.md).

docs/expressions.md

@@ -93,4 +93,4 @@ expr = F("someFunctionName", arg1, arg2, ...)
 Note that higher-order database functions (those that use lambda expressions) are not supported.
 ---
 
-[<< Models and Databases](models_and_databases.md) | [Table of Contents](toc.md) | [Querysets >>](querysets.md)
+[<< Models and Databases](models_and_databases.md) | [Table of Contents](toc.md) | [Importing ORM Classes >>](importing_orm_classes.md)

docs/querysets.md

@@ -225,4 +225,4 @@ values aggregated for all rows suitable for filters.
 
 ---
 
-[<< Expressions](expressions.md) | [Table of Contents](toc.md) | [Field Options >>](field_options.md)
+[<< Importing ORM Classes](importing_orm_classes.md) | [Table of Contents](toc.md) | [Field Options >>](field_options.md)

docs/toc.md

@@ -48,6 +48,7 @@
       * [Simple Engines](table_engines.md#simple-engines)
       * [Engines in the MergeTree Family](table_engines.md#engines-in-the-mergetree-family)
          * [Custom partitioning](table_engines.md#custom-partitioning)
+         * [Primary key](table_engines.md#primary-key)
          * [Data Replication](table_engines.md#data-replication)
       * [Buffer Engine](table_engines.md#buffer-engine)
       * [Merge Engine](table_engines.md#merge-engine)
@@ -117,8 +118,7 @@
       * [infi.clickhouse_orm.query](class_reference.md#infi.clickhouse_orm.query)
          * [QuerySet](class_reference.md#queryset)
          * [AggregateQuerySet](class_reference.md#aggregatequeryset)
+         * [Q](class_reference.md#q)
       * [infi.clickhouse_orm.funcs](class_reference.md#infi.clickhouse_orm.funcs)
          * [F](class_reference.md#f)
-      * [infi.clickhouse_orm.system_models](class_reference.md#infi.clickhouse_orm.system_models)
-         * [SystemPart](class_reference.md#systempart)
 

scripts/generate_ref.py

@@ -135,6 +135,6 @@ if __name__ == '__main__':
     module_doc([models.Model, models.BufferModel, models.DistributedModel])
     module_doc(sorted([fields.Field] + all_subclasses(fields.Field), key=lambda x: x.__name__), False)
     module_doc([engines.Engine] + all_subclasses(engines.Engine), False)
-    module_doc([query.QuerySet, query.AggregateQuerySet])
+    module_doc([query.QuerySet, query.AggregateQuerySet, query.Q])
     module_doc([funcs.F])
     module_doc([system_models.SystemPart])

src/infi/clickhouse_orm/__init__.py

@@ -1 +1,13 @@
 __import__("pkg_resources").declare_namespace(__name__)
+
+from infi.clickhouse_orm.database import *
+from infi.clickhouse_orm.engines import *
+from infi.clickhouse_orm.fields import *
+from infi.clickhouse_orm.funcs import *
+from infi.clickhouse_orm.migrations import *
+from infi.clickhouse_orm.models import *
+from infi.clickhouse_orm.query import *
+from infi.clickhouse_orm.system_models import *
+
+from inspect import isclass
+__all__ = [c.__name__ for c in locals().values() if isclass(c)]

src/infi/clickhouse_orm/database.py

@@ -411,3 +411,7 @@ class Database(object):
     def _is_connection_readonly(self):
         r = self._send("SELECT value FROM system.settings WHERE name = 'readonly'")
         return r.text.strip() != '0'
+
+
+# Expose only relevant classes in import *
+__all__ = [c.__name__ for c in [Page, DatabaseException, ServerError, Database]]

src/infi/clickhouse_orm/engines.py

@@ -2,7 +2,7 @@ from __future__ import unicode_literals
 
 import logging
 
-from .utils import comma_join
+from .utils import comma_join, get_subclass_names
 
 logger = logging.getLogger('clickhouse_orm')
 
@@ -262,3 +262,7 @@ class Distributed(Engine):
         if self.sharding_key:
             params.append(self.sharding_key)
         return params
+
+
+# Expose only relevant classes in import *
+__all__ = get_subclass_names(locals(), Engine)

src/infi/clickhouse_orm/fields.py

@@ -6,7 +6,7 @@ from calendar import timegm
 from decimal import Decimal, localcontext
 from uuid import UUID
 from logging import getLogger
-from .utils import escape, parse_array, comma_join, string_or_func
+from .utils import escape, parse_array, comma_join, string_or_func, get_subclass_names
 from .funcs import F, FunctionOperatorsMixin
 from ipaddress import IPv4Address, IPv6Address
 
@@ -598,3 +598,8 @@ class LowCardinalityField(Field):
         if with_default_expression:
             sql += self._extra_params(db)
         return sql
+
+
+# Expose only relevant classes in import *
+__all__ = get_subclass_names(locals(), Field)
+

src/infi/clickhouse_orm/funcs.py

@@ -1812,3 +1812,7 @@ class F(Cond, FunctionOperatorsMixin, metaclass=FMeta):
     def greatest(x, y):
         return F('greatest', x, y)
 
+
+# Expose only relevant classes in import *
+__all__ = ['F']
+

src/infi/clickhouse_orm/migrations.py

@@ -1,7 +1,7 @@
 from .models import Model, BufferModel
 from .fields import DateField, StringField
 from .engines import MergeTree
-from .utils import escape
+from .utils import escape, get_subclass_names
 
 import logging
 logger = logging.getLogger('migrations')
@@ -177,3 +177,7 @@ class MigrationHistory(Model):
     @classmethod
     def table_name(cls):
         return 'infi_clickhouse_orm_migrations'
+
+
+# Expose only relevant classes in import *
+__all__ = get_subclass_names(locals(), Operation)

src/infi/clickhouse_orm/models.py

@@ -7,7 +7,7 @@ from six import reraise
 import pytz
 
 from .fields import Field, StringField
-from .utils import parse_tsv, NO_VALUE
+from .utils import parse_tsv, NO_VALUE, get_subclass_names
 from .query import QuerySet
 from .funcs import F
 from .engines import Merge, Distributed
@@ -459,3 +459,5 @@ class DistributedModel(Model):
         return '\n'.join(parts)
 
 
+# Expose only relevant classes in import *
+__all__ = get_subclass_names(locals(), Model)

src/infi/clickhouse_orm/query.py

@@ -646,3 +646,7 @@ class AggregateQuerySet(QuerySet):
         qs = copy(self)
         qs._grouping_with_totals = True
         return qs
+
+
+# Expose only relevant classes in import *
+__all__ = [c.__name__ for c in [Q, QuerySet, AggregateQuerySet]]

src/infi/clickhouse_orm/system_models.py

@@ -158,3 +158,7 @@ class SystemPart(Model):
             conditions += ' AND '
         conditions += 'active'
         return SystemPart.get(database, conditions=conditions)
+
+
+# Expose only relevant classes in import *
+__all__ = [c.__name__ for c in [SystemPart]]

src/infi/clickhouse_orm/utils.py

@@ -114,6 +114,11 @@ def is_iterable(obj):
         return False
 
 
+def get_subclass_names(locals, base_class):
+    from inspect import isclass
+    return [c.__name__ for c in locals.values() if isclass(c) and issubclass(c, base_class)]
+
+
 class NoValue:
     '''
     A sentinel for fields with an expression for a default value,

tests/test_alias_fields.py

@@ -6,6 +6,7 @@ from infi.clickhouse_orm.database import Database
 from infi.clickhouse_orm.models import Model, NO_VALUE
 from infi.clickhouse_orm.fields import *
 from infi.clickhouse_orm.engines import *
+from infi.clickhouse_orm.funcs import F
 
 
 class AliasFieldsTest(unittest.TestCase):

tests/test_database.py

@@ -7,6 +7,7 @@ from infi.clickhouse_orm.database import ServerError, DatabaseException
 from infi.clickhouse_orm.models import Model
 from infi.clickhouse_orm.engines import Memory
 from infi.clickhouse_orm.fields import *
+from infi.clickhouse_orm.funcs import F
 from .base_test_with_data import *
 
 

tests/test_datetime_fields.py

@@ -1,5 +1,7 @@
 from __future__ import unicode_literals
 import unittest
+import datetime
+import pytz
 
 from infi.clickhouse_orm.database import Database
 from infi.clickhouse_orm.models import Model

tests/test_engines.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
 import unittest
+import datetime
 
 from infi.clickhouse_orm.system_models import SystemPart
 from infi.clickhouse_orm.database import Database, DatabaseException, ServerError

tests/test_funcs.py

@@ -2,9 +2,14 @@ import unittest
 from .base_test_with_data import *
 from .test_querysets import SampleModel
 from datetime import date, datetime, tzinfo, timedelta
+import pytz
 from ipaddress import IPv4Address, IPv6Address
+import logging
+from decimal import Decimal
+
 from infi.clickhouse_orm.database import ServerError
 from infi.clickhouse_orm.utils import NO_VALUE
+from infi.clickhouse_orm.funcs import F
 
 
 class FuncsTestCase(TestCaseWithData):
@@ -14,28 +19,28 @@ class FuncsTestCase(TestCaseWithData):
         self.database.insert(self._sample_data())
 
     def _test_qs(self, qs, expected_count):
-        logger.info(qs.as_sql())
+        logging.info(qs.as_sql())
         count = 0
         for instance in qs:
             count += 1
-            logger.info('\t[%d]\t%s' % (count, instance.to_dict()))
+            logging.info('\t[%d]\t%s' % (count, instance.to_dict()))
         self.assertEqual(count, expected_count)
         self.assertEqual(qs.count(), expected_count)
 
     def _test_func(self, func, expected_value=NO_VALUE):
         sql = 'SELECT %s AS value' % func.to_sql()
-        logger.info(sql)
+        logging.info(sql)
         result = list(self.database.select(sql))
-        logger.info('\t==> %s', result[0].value if result else '<empty>')
+        logging.info('\t==> %s', result[0].value if result else '<empty>')
         if expected_value != NO_VALUE:
             self.assertEqual(result[0].value, expected_value)
         return result[0].value if result else None
 
     def _test_aggr(self, func, expected_value=NO_VALUE):
         qs = Person.objects_in(self.database).aggregate(value=func)
-        logger.info(qs.as_sql())
+        logging.info(qs.as_sql())
         result = list(qs)
-        logger.info('\t==> %s', result[0].value if result else '<empty>')
+        logging.info('\t==> %s', result[0].value if result else '<empty>')
         if expected_value != NO_VALUE:
             self.assertEqual(result[0].value, expected_value)
         return result[0].value if result else None

tests/test_materialized_fields.py

@@ -6,6 +6,7 @@ from infi.clickhouse_orm.database import Database
 from infi.clickhouse_orm.models import Model, NO_VALUE
 from infi.clickhouse_orm.fields import *
 from infi.clickhouse_orm.engines import *
+from infi.clickhouse_orm.funcs import F
 
 
 class MaterializedFieldsTest(unittest.TestCase):

tests/test_querysets.py

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals, print_function
 import unittest
-
 from infi.clickhouse_orm.database import Database
 from infi.clickhouse_orm.query import Q
 from infi.clickhouse_orm.funcs import F
 from .base_test_with_data import *
 from datetime import date, datetime
 from enum import Enum
+from decimal import Decimal
 
 from logging import getLogger
 logger = getLogger('tests')