Basic support for MSI / Plessey #191

petaflot · 2022-12-10T13:44:56Z

also allows encoding of strings and bytestrings (allows encoding any symbol) by converting them to int ; in this case, string representation is shown in human-readable string

for more information, see https://pre-commit.ci

petaflot · 2022-12-10T13:58:08Z

#190

byteorder and encoding parameters default to None ; user must specifically set them to enable conversion of strings or bytes

for more information, see https://pre-commit.ci

codecov · 2022-12-10T14:17:08Z

Codecov Report

Base: 80.63% // Head: 79.36% // Decreases project coverage by -1.26% ⚠️

Coverage data is based on head (ba6ce09) compared to base (f3a7046).
Patch coverage: 39.28% of modified lines in pull request are covered.

❗ Current head ba6ce09 differs from pull request most recent head 943acae. Consider uploading reports for the commit 943acae to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #191      +/-   ##
==========================================
- Coverage   80.63%   79.36%   -1.27%     
==========================================
  Files          17       17              
  Lines         888      916      +28     
==========================================
+ Hits          716      727      +11     
- Misses        172      189      +17

Impacted Files	Coverage Δ
barcode/codex.py	`77.18% <37.03%> (-6.06%)`	⬇️
barcode/__init__.py	`96.00% <100.00%> (+0.08%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

WhyNotHugo

Wikipedia says "The MSI bar code represents only digits 0–9; it does not support letters or symbols.".

Is the approach taken for encoding strings a standard one? Do you have a reference for it?

WhyNotHugo · 2022-12-10T16:09:35Z

barcode/codex.py

@@ -129,7 +129,7 @@ class Code128(Barcode):
            The writer to render the barcode (default: SVGWriter).
    """

-    name = "Code 128"
+    ame = "Code 128"


oops :-s my keyboard is depressed

WhyNotHugo · 2022-12-10T16:14:56Z

barcode/codex.py

+    :parameters:
+        code : int or bytes or string
+            Code MSI int without checksum (added automatically).
+            Code MSI bytes without checksum. requires byteorder for int conversion
+            Code MSI string without checksum. requires encoding and byteorder for int conversion
+        writer : barcode.writer Instance
+            The writer to render the barcode (default: SVGWriter).
+        byteorder : string
+            'big' or 'little' ; to convert bytes to int
+        encoding : string
+            if set, convert bytes to string and use this as a label. defaults to utf-8


Please use regular sphinx format here so docs render properly.

Suggested change

:parameters:

code : int or bytes or string

Code MSI int without checksum (added automatically).

Code MSI bytes without checksum. requires byteorder for int conversion

Code MSI string without checksum. requires encoding and byteorder for int conversion

writer : barcode.writer Instance

The writer to render the barcode (default: SVGWriter).

byteorder : string

'big' or 'little' ; to convert bytes to int

encoding : string

if set, convert bytes to string and use this as a label. defaults to utf-8

:param code: Code MSI int without checksum (added automatically).

Code MSI bytes without checksum. requires byteorder for int conversion

Code MSI string without checksum. requires encoding and byteorder for int conversion

:param writer: The writer to render the barcode (default: SVGWriter).

:param byteorder: 'big' or 'little' ; to convert bytes to int

:param encoding : if set, convert bytes to string and use this as a label. defaults to utf-8

I had copied the format from Code128... last commit fixes other docstrings in codex.py

WhyNotHugo · 2022-12-10T16:15:08Z

barcode/codex.py

+
+    name = "MSI/Modified Plessey"
+
+    def __init__(self, code, writer=None, byteorder=None, encoding=None):


Type annotations missing.

Can you please help me with this? I don't know how to do it when multiple types are allowed.

I have severe back and joint issues that are made much worse when sitting for extended periods of time, so I will not dig further into an obscure doc to find out.

petaflot · 2022-12-10T16:47:43Z

it's not standard at all (hence the new defaults). it's a workaround because no 1D barcode that I know of can encode arbitrary bytes (at most a variant of extended ASCII)

the MSI barcode will encode just an int (hence the new default values for "byteorder" and "encoding" : the user must force this workaround, otherwise an exception will be raised at init. I specifically chose to use MSI for this purpose, because since it normally allows only integer encoding the risk of confusion is minimal (user has to explicitly force the conversion : the same approach with ie. Code128 would get very confusing)

does this seem like a reasonable approach? it's a quite inefficient method of encoding data (mostly because of BCD being inefficient in itself) but if the purpose is just to encode short strings it's acceptable. the code could be extended to split longer strings on multiple lines (sort-of like DataBar does) that could be read sequentially.

petaflot · 2022-12-10T16:52:11Z

also, from https://www.dynamsoft.com/blog/insights/the-comprehensive-guide-to-1d-and-2d-barcodes/ :

MSI Codes are used in inventory management to mark shelves and containers to identify storage locations.

Industry

    Inventory
    Warehousing

This basically means that MSI codes are used "internally" by organizations, so it is unlikely that any "consumer" will stumble on such a code (those codes are used in a specific context) ; this is - again - less chance for confusion

printing the decoded string under the barcode lessens even more the risk of confusion

FIY, for displaying bytestrings that cannot be decoded (I have a great deal of those), I wrote https://github.com/petaflot/bytes_as_braille ; I am likely to add a "label" argument to MSI.init() to let the user specify the label - I didn't want to make bytes_as_braille a dependency of python-barcode

to encode strings, just use something else (such as Code128)

for more information, see https://pre-commit.ci

petaflot · 2022-12-10T17:09:23Z

added type hints
removed option to encode strings (it's not standard and other barcode types can do it better)
default encoding to 'utf-8' again to limit risk of confusion
user-specifiable label

(also for other types in same file)

for more information, see https://pre-commit.ci

>>> type(None) <class 'NoneType'> /me confused

for more information, see https://pre-commit.ci

those checks are getting on my nerves ad making things very slow

rmkane · 2023-04-06T19:34:36Z

The JsBarcode project includes multiple implementations of MSI:

MSI
MSI10
MSI1010
MSI11
MSI1110

petaflot · 2023-04-10T16:37:16Z

The JsBarcode project includes multiple implementations of MSI:
* MSI

* MSI10

* MSI1010

* MSI11

* MSI1110

isn't that javascript?

rmkane · 2023-04-10T16:49:21Z

The JsBarcode project includes multiple implementations of MSI:
* MSI

* MSI10

* MSI1010

* MSI11

* MSI1110
isn't that javascript?

It is, but porting the code over to Python would be an easy task. I was just citing it as an implementation of MSI.

WhyNotHugo · 2023-04-20T16:10:38Z

barcode/codex.py

+            if encoding is not None:
+                self.label = code.decode(encoding)
+            else:
+                self.label = self.code if label is None else label


There's no variable named label in this scope.

Jesus Zen Droïd and others added 3 commits December 9, 2022 11:41

MSI barcodes, with bytes/strings encoding

46d61ed

typo + better docstrings

037bf5b

[pre-commit.ci] auto fixes from pre-commit.com hooks

ce27899

for more information, see https://pre-commit.ci

petaflot mentioned this pull request Dec 10, 2022

no support for MSI (Plessey) barcodes #190

Open

Jesus Zen Droïd and others added 2 commits December 10, 2022 15:16

fixed silly mistake, more sensible defaults

92e90d5

byteorder and encoding parameters default to None ; user must specifically set them to enable conversion of strings or bytes

[pre-commit.ci] auto fixes from pre-commit.com hooks

2d56b80

for more information, see https://pre-commit.ci

petaflot changed the title ~~fix for #190~~ Basic support for MSI / Plessey Dec 10, 2022

WhyNotHugo reviewed Dec 10, 2022

View reviewed changes

Jesus Zen Droïd and others added 2 commits December 10, 2022 18:07

removed code-can-be-string, added type hints

7505382

to encode strings, just use something else (such as Code128)

[pre-commit.ci] auto fixes from pre-commit.com hooks

201c07d

for more information, see https://pre-commit.ci

Jesus Zen Droïd and others added 15 commits December 10, 2022 18:12

use regular sphinx format

bac523d

(also for other types in same file)

[pre-commit.ci] auto fixes from pre-commit.com hooks

f5118db

for more information, see https://pre-commit.ci

depressed keyboard

03dbda8

fixes for failed test

3b26a75

[pre-commit.ci] auto fixes from pre-commit.com hooks

e38637c

for more information, see https://pre-commit.ci

NoneType is... not a type

079d2b5

>>> type(None) <class 'NoneType'> /me confused

stilly very new to this...

fe993d7

this is annoying

523d2cd

import

71d3fe1

[pre-commit.ci] auto fixes from pre-commit.com hooks

4bc63a6

for more information, see https://pre-commit.ci

more errors

097591f

don't know how to do that

51e1a79

[pre-commit.ci] auto fixes from pre-commit.com hooks

ba6ce09

for more information, see https://pre-commit.ci

more explicit

59f0776

this is getting ridiculous.

84881a4

Jesus Zen Droïd added 10 commits December 10, 2022 18:36

whatever.

1428670

those checks are getting on my nerves ad making things very slow

removed stupid try/except

a3e3aec

setting label when code is int

4a822b1

background can be omitted

47f557c

just found out about 'text' argument to save()

854a1ff

just found out about 'text' argument to save()

02c5f44

meeh. doing label a bit more "right"

aed1d4b

background can be omitted

2cfaad4

meeh. doing label a bit more "right"

eebc2c5

Merge branch 'MSI'

943acae

WhyNotHugo reviewed Apr 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Basic support for MSI / Plessey #191

Basic support for MSI / Plessey #191

petaflot commented Dec 10, 2022

petaflot commented Dec 10, 2022

codecov bot commented Dec 10, 2022 •

edited

WhyNotHugo left a comment

WhyNotHugo Dec 10, 2022

petaflot Dec 10, 2022 •

edited

WhyNotHugo Dec 10, 2022

petaflot Dec 10, 2022

WhyNotHugo Dec 10, 2022

petaflot Dec 11, 2022

petaflot commented Dec 10, 2022 •

edited

petaflot commented Dec 10, 2022 •

edited

petaflot commented Dec 10, 2022

rmkane commented Apr 6, 2023

petaflot commented Apr 10, 2023

rmkane commented Apr 10, 2023

WhyNotHugo Apr 20, 2023


		name = "MSI/Modified Plessey"

		def __init__(self, code, writer=None, byteorder=None, encoding=None):

Basic support for MSI / Plessey #191

Are you sure you want to change the base?

Basic support for MSI / Plessey #191

Conversation

petaflot commented Dec 10, 2022

petaflot commented Dec 10, 2022

codecov bot commented Dec 10, 2022 • edited

Codecov Report

WhyNotHugo left a comment

Choose a reason for hiding this comment

WhyNotHugo Dec 10, 2022

Choose a reason for hiding this comment

petaflot Dec 10, 2022 • edited

Choose a reason for hiding this comment

WhyNotHugo Dec 10, 2022

Choose a reason for hiding this comment

petaflot Dec 10, 2022

Choose a reason for hiding this comment

WhyNotHugo Dec 10, 2022

Choose a reason for hiding this comment

petaflot Dec 11, 2022

Choose a reason for hiding this comment

petaflot commented Dec 10, 2022 • edited

petaflot commented Dec 10, 2022 • edited

petaflot commented Dec 10, 2022

rmkane commented Apr 6, 2023

petaflot commented Apr 10, 2023

rmkane commented Apr 10, 2023

WhyNotHugo Apr 20, 2023

Choose a reason for hiding this comment

codecov bot commented Dec 10, 2022 •

edited

petaflot Dec 10, 2022 •

edited

petaflot commented Dec 10, 2022 •

edited

petaflot commented Dec 10, 2022 •

edited