Merge pull request #138 from FerroEduardo/enhancements

Fixes emoji module, create normaliser tests and add automatic test

.github/workflows/tests.yaml

@@ -0,0 +1,29 @@
+name: test
+
+on: 
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .
+          python -m pip install pytest pytest-cov
+      - name: Test with pytest
+        run: |
+          pytest tests/ --cov=enelvo/

.travis.yml

@@ -4,6 +4,8 @@ python:
   - "3.6"
   - "3.7"
   - "3.8"
+  - "3.9"
+  - "3.10"
 
 before_install:
   - pip install poetry

README.md

@@ -6,6 +6,7 @@
 <h4 align="center">A flexible normaliser for user-generated content in Portuguese.</h4>
 
 <p align="center">
+<a href="https://github.com/thalesbertaglia/enelvo/actions/workflows/tests.yaml"><img alt="tests" src="https://github.com/thalesbertaglia/enelvo/actions/workflows/tests.yaml/badge.svg"></a>
 <a href="https://travis-ci.org/thalesbertaglia/enelvo"><img alt="Build Status" src="https://travis-ci.org/thalesbertaglia/enelvo.svg?branch=master"></a>
 <a href='https://coveralls.io/github/thalesbertaglia/enelvo?branch=master'><img src='https://coveralls.io/repos/github/thalesbertaglia/enelvo/badge.svg?branch=master' alt='Coverage Status' /></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>

enelvo/candidate_generation/embeddings.py

@@ -2,11 +2,9 @@
 
 # Author: Thales Bertaglia <thalesbertaglia@gmail.com>
 
-import gensim
 import pickle
 from enelvo import metrics
 from enelvo import candidate_scoring
-from enelvo import utils
 from enelvo.candidate_generation import baselines
 
 

enelvo/candidate_scoring/embeddings.py

@@ -2,7 +2,6 @@
 
 # Author: Thales Bertaglia <thalesbertaglia@gmail.com>
 
-import pickle
 from enelvo import metrics
 
 

enelvo/preprocessing/preprocessing.py

@@ -1,6 +1,6 @@
 """Preprocessing methods."""
 from .tokenizer import Tokenizer
-from emoji import UNICODE_EMOJI
+import emoji
 import string
 import os.path
 
@@ -70,7 +70,7 @@ def sanitize(text, as_string=False):
     clean = [
         w.strip()
         for w in tokens
-        if w not in emoticons and w not in UNICODE_EMOJI and len(w) != 0
+        if w not in emoticons and emoji.emoji_count(w) == 0 and len(w) != 0
     ]
     return clean if not as_string else " ".join(clean)
 

enelvo/preprocessing/tokenizer/tokenizer.py

@@ -9,9 +9,8 @@
 # Adapted to Portuguese by Thales Bertaglia <thalesbertaglia@gmail.com>
 
 import re
-import string
 from os import path
-from emoji import UNICODE_EMOJI
+import emoji
 
 from html.entities import name2codepoint
 
@@ -72,7 +71,7 @@ def _isemoji(s):
         len(s) == len("\U0001f4a9")
         and any(l <= s <= u for l, u in emoji_ranges)
         or s in emoji_flags
-        or s in UNICODE_EMOJI
+        or emoji.emoji_count(s) > 0
     )
 
 

enelvo/utils/evaluation.py

@@ -2,8 +2,6 @@
 
 # Author: Thales Bertaglia <thalesbertaglia@gmail.com>
 
-from tabulate import tabulate
-
 
 def evaluate_candidate_generation(list_corrections, list_candidates):
     """Returns the recall (in %) of candidate generation methods.

pyproject.toml

@@ -17,7 +17,7 @@ editdistance = ">=0.6.0"
 numpy = ">=1.19.5"
 gensim = ">=4.1.2"
 tabulate = ">=0.8.9"
-emoji = ">=1.6.3"
+emoji = "2.2.0"
 
 [tool.poetry.dev-dependencies]
 coveralls = ">=3.3.1"

tests/test_normaliser.py

@@ -0,0 +1,58 @@
+from enelvo import normaliser
+
+def test_raw():
+    norm = normaliser.Normaliser()
+    assert norm.normalise('Que dia lindo') == 'que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'hoje eu vou dar uma voltinha 😀'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'vou dar uma passada na casa do eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'domingo é dia de paredão no bbb'
+    assert norm.normalise('#python > #javascript') == 'hashtag > hashtag'
+
+def test_sanitize():
+    norm = normaliser.Normaliser(sanitize=True)
+    assert norm.normalise('Que dia lindo') == 'que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'hoje eu vou dar uma voltinha'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'vou dar uma passada na casa do eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'domingo é dia de paredão no bbb'
+    assert norm.normalise('#python > #javascript') == 'hashtag hashtag'
+
+def test_capitalize_pns():
+    norm = normaliser.Normaliser(capitalize_pns=True)
+    assert norm.normalise('Que dia lindo') == 'que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'hoje eu vou dar uma voltinha 😀'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'vou dar uma passada na casa do Eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'domingo é dia de paredão no bbb'
+    assert norm.normalise('#python > #javascript') == 'Hashtag > Hashtag'
+
+def test_capitalize_inis():
+    norm = normaliser.Normaliser(capitalize_inis=True)
+    assert norm.normalise('Que dia lindo') == 'Que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'Hoje eu vou dar uma voltinha 😀'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'Vou dar uma passada na casa do eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'Domingo é dia de paredão no bbb'
+    assert norm.normalise('#python > #javascript') == 'Hashtag > hashtag'
+
+def test_capitalize_acs():
+    norm = normaliser.Normaliser(capitalize_acs=True)
+    assert norm.normalise('Que dia lindo') == 'que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'hoje eu vou dar uma voltinha 😀'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'vou dar uma passada na casa do eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'domingo é dia de paredão no BBB'
+    assert norm.normalise('#python > #javascript') == 'hashtag > hashtag'
+
+def test_readable_tokenizer():
+    norm = normaliser.Normaliser(tokenizer='readable')
+    assert norm.normalise('Que dia lindo') == 'que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'hoje eu vou dar uma voltinha 😀'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'vou dar uma passada na casa do eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'domingo é dia de paredão no bbb'
+    assert norm.normalise('#python > #javascript') == '#python > #javascript'
+
+def test_all():
+    norm = normaliser.Normaliser(sanitize=True, capitalize_pns=True, capitalize_inis=True, capitalize_acs=True, tokenizer='readable')
+    assert norm.normalise('Que dia lindo') == 'Que dia lindo'
+    assert norm.normalise('Hoje eu vou dar uma voltinha 😀') == 'Hoje eu vou dar uma voltinha'
+    assert norm.normalise('Vou dar uma passada na casa do Eduardo') == 'Vou dar uma passada na casa do Eduardo'
+    assert norm.normalise('Domingo é dia de paredão no BBB') == 'Domingo é dia de paredão no BBB'
+    assert norm.normalise('#python > #javascript') == 'python javascript'
+