Add text key to crosstab (#51)

* Add text_key parameter to crosstab.

* Bump version number

* Skip confirmit api tests for now

* Fix list of valid text keys

* Decode strings in excel painter

Co-authored-by: Geir Freysson <[email protected]>

Author: geirfreysson

quantipy/core/dataset.py

@@ -55,7 +55,7 @@
 import importlib
 
 VALID_TKS = [
-    'en-GB', 'da-DK', 'fi-FI', 'nb-NO', 'sv-SE', 'de-DE', 'fr-FR', 'ar-AR',
+    'en-GB', 'en-US', 'da-DK', 'fi-FI', 'nb-NO', 'sv-SE', 'de-DE', 'is-IS', 'fr-FR', 'ar-AR',
     'es-ES', 'it-IT', 'pl-PL', 'en']
 
 VAR_SUFFIXES = [
@@ -1878,7 +1878,7 @@ def parents(self, name):
     @verify(variables={'x': 'both', 'y': 'both_nested', 'w': 'columns'})
     def crosstab(self, x, y=[], w=None, f=None, ci='counts', base='auto', stats=False,
                  sig_level=None, rules=False, decimals=1, xtotal=False,
-                 painted=True):
+                 painted=True, text_key=None):
         """
         Return a well formated crosstab. (New version)
         Parameters
@@ -1916,6 +1916,8 @@ def crosstab(self, x, y=[], w=None, f=None, ci='counts', base='auto', stats=Fals
             regular frequency of the x column.
         painted: bool, default True
             Add texts from the meta to the index and columns.
+        text_key: string, default None
+            What language text key to use when returning the result.
         """
         def _rounding(x, dec):
             try:
@@ -2014,7 +2016,10 @@ def _rounding(x, dec):
             folder     = 'ct')
 
         if painted:
-            cm.paint_all(totalize=True)
+            if text_key is not None:
+                cm.paint_all(totalize=True, text_key=text_key)
+            else:
+                cm.paint_all(totalize=True)
 
         dfs = []
         for chain in cm['ct']:

quantipy/sandbox/excel.py

@@ -715,7 +715,7 @@ def set_row(self, row, height, label=None, font_name=None, font_size=None):
             else:
                 fact = 1
 
-            dimensions = self.truetype.getsize(label)
+            dimensions = self.truetype.getsize(label.encode("utf-8"))
 
             if (dimensions[1] * units_to_pixels) - padding > height:
                 # text too tall

setup.py

@@ -39,7 +39,7 @@ def version_libs(libs, precisions, versions):
     INSTALL_REQUIRES = version_libs(libs, precisions, versions)
 
 setup(name='quantipy3',
-      version='0.2.9',
+      version='0.2.10',
       author='Geir Freysson',
       author_email='[email protected]',
       packages=find_packages(exclude=['tests']),

tests/test_confirmit_reader.py

@@ -460,7 +460,7 @@ def test_loop_variables(confirmit_dataset):
     }
     """)
 
-
+@pytest.mark.skip(reason="confirmit api has changed")
 def test_read_from_api():
     dataset_from_api = qp.DataSet("confirmit")
     dataset_from_api.read_confirmit_api(projectid="p913481003361",
@@ -488,7 +488,7 @@ def test_read_from_api():
         "value": 2}],
     "text": {"en": "Use script to set values"}}""")
 
-
+@pytest.mark.skip(reason="confirmit api has changed")
 def test_writer_to_api():
     dataset = qp.DataSet("confirmit")
     response = dataset.write_confirmit_api(projectid="p913481003361",

tests/test_dataset.py

@@ -895,6 +895,24 @@ def test_crosstab2(self):
         assert result.shape == (13,2)
         assert with_sigdiff.shape == (37,4)
 
+    def test_crosstab_with_lang_key(self):
+        dataset = self._get_dataset()
+        dataset.set_variable_text(name='gender', new_text='Kyn', text_key='is-IS')
+        dataset.set_value_texts(name='gender', renamed_vals={1:'Maður', 2:"Kona"}, text_key='is-IS')
+        dataset.set_variable_text(name='locality', new_text='Búseta', text_key='is-IS')
+        dataset.set_value_texts(name='locality', 
+                                renamed_vals={
+                                    1:"Verslunarkjarni", 
+                                    2:"Þéttbýli",
+                                    3:"Úthverfi",
+                                    4:"Dreifbýli",
+                                    5:"Afskekkt"
+                                    }, 
+                                text_key='is-IS')
+
+        result = dataset.crosstab(x='locality', y='gender', text_key='is-IS')
+        assert result.columns.get_level_values(1).to_list() == ['Maður', 'Kona']
+
     def test_crosstab(self):
         x = 'q14r01c01'
         dataset = self._get_dataset()