Initial commit

Author: suda

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+.DS_Store
+*.egg-info

README.md

@@ -0,0 +1,48 @@
+# Emoji encoding for 🐍
+
+This module provides a custom source code encoding allowing usage of Emoji's for things like variable names or function names.
+
+## Usage
+
+Install the package with pip:
+```
+pip install emoji-encoding
+```
+**It's recommended to install it in [a virtualenv](https://virtualenv.readthedocs.org/en/latest/)**
+
+After installation you can specify the encoding in the beginning of a Python file:
+
+```python
+# -*- coding: emoji -*-
+def 📢(✉️):
+    print(✉️)
+
+📢("✋ 🌏")
+```
+
+## Uninstalling
+
+This package will create `emoji.pth` file in your `site-packages` directory to autoload the codec. After removing the module you need to remove this file manually.
+
+## Known issues
+
+Currently the encoding is only available in imported modules so trying to run Emoji encoded file directly will fail:
+
+```
+$ python emoji.py
+  File "emoji.py", line 1
+SyntaxError: encoding problem: emoji
+```
+
+Easy workaround is to have an another file that imports the Emoji encoded file:
+
+```shell
+$ cat bootstrap.py
+import emoji
+$ python bootstrap.py
+✋ 🌏
+```
+
+## History
+
+It all started with Ola Sendecka's talk about [Emoji Driven Development](https://speakerdeck.com/jezdezcon/ola-sendecka-emoji-driven-development) which made me wonder: "why *can't* we use Emoji's in Python?". After a bit of hacking I was able to use them [with a patched cpython](https://twitter.com/suda/status/614814994367168512). This wasn't a perfect solution so playing with this idea I ended up with custom [codec](https://docs.python.org/3/library/codecs.html) that translates Emoji's to their ASCII representations and adds prefix/suffix to decode such unique string back to Unicode.

emoji.pth

@@ -0,0 +1 @@
+import sys; from emojiencoding import bootstrap

emojiencoding/__init__.py

@@ -0,0 +1,7 @@
+from . import emoji
+
+import sys, codecs
+if sys.stdout.encoding != 'emoji':
+    sys.stdout = codecs.getwriter('emoji')(sys.stdout.buffer, 'strict')
+if sys.stderr.encoding != 'emoji':
+    sys.stderr = codecs.getwriter('emoji')(sys.stderr.buffer, 'strict')

emojiencoding/bootstrap.py

@@ -0,0 +1,61 @@
+import codecs
+import emote
+import re
+
+decoding_prefix = "emoji_start_"
+decoding_sufix = "_emoji_end"
+# TODO: Make regex non greedy
+decoding_pattern = re.compile("%s([\w\-]+)%s" % (decoding_prefix, decoding_sufix))
+try:
+    # UCS-4
+    highpoints = re.compile(u'([\U00002600-\U000027BF])|([\U0001f300-\U0001f64F])|([\U0001f680-\U0001f6FF])')
+except re.error:
+    # UCS-2
+    highpoints = re.compile(u'([\u2600-\u27BF])|([\uD83C][\uDF00-\uDFFF])|([\uD83D][\uDC00-\uDE4F])|([\uD83D][\uDE80-\uDEFF])')
+
+class EmojiCodec(codecs.Codec):
+    def encode(self, input, errors='strict'):
+        emojis = decoding_pattern.finditer(input)
+        for emoji in emojis:
+            emoji_string = emoji.group(1)
+            input = input.replace(emoji.group(0), emote.lookup(emoji_string))
+        return (input.encode('utf8'), len(input))
+
+    def decode(self, input, errors='strict'):
+        input_string = codecs.decode(input, 'utf8')
+        emojis = highpoints.finditer(input_string)
+
+        for emoji in emojis:
+            emoji_string = emoji.group(0)
+            substitute = "%s%s%s" % (decoding_prefix, emote.decode(emoji_string), decoding_sufix)
+            input_string = input_string.replace(emoji_string, substitute)
+        return (input_string, len(input))
+
+class EmojiIncrementalEncoder(codecs.IncrementalEncoder):
+    def encode(self, input, final=False):
+        return EmojiCodec().encode(input)
+
+class EmojiIncrementalDecoder(codecs.IncrementalDecoder):
+    def decode(self, input, final=False):
+        return EmojiCodec().decode(input)
+
+class EmojiStreamReader(EmojiCodec, codecs.StreamReader):
+    pass
+
+class EmojiStreamWriter(EmojiCodec, codecs.StreamWriter):
+    pass
+
+def search(encoding):
+    if encoding == "emoji":
+        return codecs.CodecInfo(
+            name='emoji',
+            encode=EmojiCodec().encode,
+            decode=EmojiCodec().decode,
+            incrementalencoder=EmojiIncrementalEncoder,
+            incrementaldecoder=EmojiIncrementalDecoder,
+            streamreader=EmojiStreamReader,
+            streamwriter=EmojiStreamWriter,
+        )
+    return None
+
+codecs.register(search)

emojiencoding/emoji.py

@@ -0,0 +1,5 @@
+# -*- coding: emoji -*-
+def 📢(✉️):
+    print(✉️)
+
+📢("✋ 🌏")

example.py

@@ -0,0 +1,14 @@
+from distutils.sysconfig import get_python_lib
+from shutil import copyfile
+from os import path
+
+def main():
+    here = path.abspath(path.dirname(__file__))
+    print('Copying 'emoji.pth' to %s' % get_python_lib())
+    copyfile(
+        path.join(here, 'emoji.pth'),
+        path.join(get_python_lib(), 'emoji.pth')
+    )
+
+if __name__ == '__main__':
+    main()

post_setup.py

@@ -0,0 +1,5 @@
+[bdist_wheel]
+# This flag says that the code is written to work on both Python 2 and Python
+# 3. If at all possible, it is good practice to do this. If you cannot, you
+# will need to generate wheels for each Python version that you support.
+universal=1

setup.cfg

@@ -0,0 +1,114 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+from setuptools.command.install import install as _install
+from setuptools.command.develop import develop as _develop
+# To use a consistent encoding
+from codecs import open
+from os import path
+
+here = path.abspath(path.dirname(__file__))
+
+from post_setup import main as post_install
+
+class CustomInstall(_install):
+    def run(self):
+        _install.run(self)
+        post_install()
+
+class CustomDevelop(_develop):
+    def run(self):
+        _develop.run(self)
+        post_install()
+
+# Get the long description from the README file
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+if __name__ == '__main__':
+    setup(
+        name='emoji_encoding',
+
+        # Versions should comply with PEP440.  For a discussion on single-sourcing
+        # the version across setup.py and the project code, see
+        # https://packaging.python.org/en/latest/single_source_version.html
+        version='0.0.1',
+
+        description='Module providing Emoji encoding for Python',
+        long_description=long_description,
+
+        # The project's main homepage.
+        url='https://github.com/suda/python-emoji-encoding',
+
+        # Author details
+        author='Wojtek Siudzinski',
+        author_email='[email protected]',
+
+        # Choose your license
+        license='MIT',
+
+        # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+        classifiers=[
+            # How mature is this project? Common values are
+            #   3 - Alpha
+            #   4 - Beta
+            #   5 - Production/Stable
+            'Development Status :: 3 - Alpha',
+
+            # Indicate who your project is intended for
+            'Intended Audience :: Developers',
+            'Topic :: Software Development :: Build Tools',
+
+            # Pick your license as you wish (should match "license" above)
+            'License :: OSI Approved :: MIT License',
+
+            # Specify the Python versions you support here. In particular, ensure
+            # that you indicate whether you support Python 2, Python 3 or both.
+            'Programming Language :: Python :: 2',
+            'Programming Language :: Python :: 2.6',
+            'Programming Language :: Python :: 2.7',
+            'Programming Language :: Python :: 3',
+            'Programming Language :: Python :: 3.2',
+            'Programming Language :: Python :: 3.3',
+            'Programming Language :: Python :: 3.4',
+            'Programming Language :: Python :: 3.5',
+        ],
+
+        # What does your project relate to?
+        keywords='emoji codec encoding',
+
+        # You can just specify the packages manually here if your project is
+        # simple. Or you can use find_packages().
+        # packages=find_packages(exclude=['contrib', 'docs', 'tests']),
+        packages=find_packages(),
+
+        # Alternatively, if you want to distribute just a my_module.py, uncomment
+        # this:
+        # py_modules=["emojicodec"],
+
+        # List run-time dependencies here.  These will be installed by pip when
+        # your project is installed. For an analysis of "install_requires" vs pip's
+        # requirements files see:
+        # https://packaging.python.org/en/latest/requirements.html
+        install_requires=['emote'],
+
+        # List additional groups of dependencies here (e.g. development
+        # dependencies). You can install these using the following syntax,
+        # for example:
+        # $ pip install -e .[dev,test]
+        extras_require={
+            'dev': ['check-manifest'],
+            'test': ['coverage'],
+        },
+
+        cmdclass={
+            'install': CustomInstall,
+            'develop': CustomDevelop,
+        },
+    )