music21.common.classTools

Functions

music21.common.classTools.classToClassStr(classObj)

Convert a class object to a class string.

>>> common.classToClassStr(note.Note)
'Note'
>>> common.classToClassStr(chord.Chord)
'Chord'
Return type:str
music21.common.classTools.getClassSet(instance, classNameTuple=None)

Return the classSet for an instance (whether a Music21Object or something else. See base.Music21Object.classSet for more details.

>>> p = pitch.Pitch()
>>> cs = common.classTools.getClassSet(p)
>>> cs
 frozenset(...)
>>> pitch.Pitch in cs
True
>>> 'music21.pitch.Pitch' in cs
True
>>> 'Pitch' in cs
True
>>> object in cs
True
>>> 'object' in cs
True

To save time (this IS a performance-critical operation), classNameTuple can be passed a tuple of names such as (‘Pitch’, ‘object’) that will save the creation time of this set.

Use base.Music21Object.classSet in general for music21Objects since it not only caches the result for each object, it caches the result for the whole class the first time it is run.

music21.common.classTools.isIterable(usrData)

Returns True if is the object can be iter’d over and is NOT a string

>>> common.isIterable([5, 10])
True
>>> common.isIterable('sharp')
False
>>> common.isIterable((None, None))
True
>>> common.isIterable(stream.Stream())
True
Return type:bool
music21.common.classTools.isListLike(usrData)

Returns True if is a List or Tuple

Formerly allowed for set here, but that does not allow for subscripting (set([1, 2, 3])[0] is undefined).

Differs from isinstance(collections.abc.Sequence()) in that we do not want Streams included even if __contains__, __reversed__, and count are added.

>>> common.isListLike([])
True
>>> common.isListLike('sharp')
False
>>> common.isListLike((None, None))
True
>>> common.isListLike(set(['a', 'b', 'c', 'c']))
False
>>> common.isListLike(stream.Stream())
False
Return type:bool
music21.common.classTools.isNum(usrData)

check if usrData is a number (float, int, long, Decimal), return boolean

unlike isinstance(usrData, Number) does not return True for True, False.

Does not use isinstance(usrData, Number) which is 6 times slower than calling this function (except in the case of Fraction, when it’s 6 times faster, but that’s rarer)

Runs by adding 0 to the “number” – so anything that implements add to a scalar works

>>> common.isNum(3.0)
True
>>> common.isNum(3)
True
>>> common.isNum('three')
False
>>> common.isNum([2, 3, 4])
False

True and False are NOT numbers:

>>> common.isNum(True)
False
>>> common.isNum(False)
False
>>> common.isNum(None)
False
Return type:bool