Initial commit

Author: Kefkius

.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+*.swp
+build/
+dist/
+hexs.egg-info/

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -0,0 +1,28 @@
+# hexs
+
+This is a very small package which contains functions that format hex strings.
+The purpose of this formatting is to make a given hex string of even length,
+remove a "0x" prefix if present, and remove a "L" suffix if present.
+
+It also includes a convenience function, `hexs()`, which calls the built-in `hex()`
+function and formats the result.
+
+## Usage
+
+```
+>>> from hexs import is_hex, hexs, format_hex
+>>> hexs(5)
+'05'
+>>> format_hex('0x5')
+'05'
+>>> is_hex('g')
+False
+>>> is_hex(29)
+False
+>>> is_hex('f')
+True
+```
+
+## License
+
+MIT License.

hexs/__init__.py

@@ -0,0 +1 @@
+from .hexs import *

hexs/hexs.py

@@ -0,0 +1,26 @@
+"""Hex string formating."""
+
+# Append 0 if the length of s is odd.
+make_even = lambda s: '0' + s if len(s) % 2 else s
+
+def is_hex(s):
+    """Return whether s is a hex string."""
+    try:
+        int(s, 16)
+    except (TypeError, ValueError):
+        return False
+    return True
+
+def format_hex(s):
+    """Remove extraneous characters from s and make its length even."""
+    return make_even(s.lstrip('0x').rstrip('L'))
+
+def hexs(arg):
+    """Return the formatted hex representation of arg."""
+    return format_hex(hex(arg))
+
+__all__ = (
+    'is_hex',
+    'format_hex',
+    'hexs',
+)

hexs/tests/__init__.py

@@ -0,0 +1,23 @@
+import unittest
+
+from hexs import is_hex, format_hex, hexs
+
+class IsHexTest(unittest.TestCase):
+    def test_is_hex(self):
+        self.assertTrue(is_hex('2'))
+        self.assertTrue(is_hex('0xf'))
+
+    def test_is_not_hex(self):
+        self.assertFalse(is_hex('0xg'))
+        self.assertFalse(is_hex(5))
+
+class FormatHexTest(unittest.TestCase):
+    def test_format_hex(self):
+        self.assertEqual('07', format_hex('0x7'))
+        self.assertEqual('01ff', format_hex('1ff'))
+        self.assertEqual('0528', format_hex('0528'))
+
+class HexsTest(unittest.TestCase):
+    def test_hexs(self):
+        self.assertEqual('07', hexs(7))
+        self.assertEqual('0100', hexs(256))

hexs/tests/test_hex.py

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.cfg

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+version = '1.0.0'
+
+
+setup(
+    name = 'hexs',
+    version = version,
+    description = 'Hex string formatting.',
+    url = 'https://github.com/kefkius/hexs',
+    author = 'Tyler Willis',
+    author_email = 'kefkius@mail.com',
+    keywords = [
+        'hex',
+        'formatting',
+    ],
+    classifiers = [
+        'License :: OSI Approved :: MIT License',
+    ],
+    packages = find_packages(),
+    test_suite = 'hexs.tests'
+)