pychord package

Subpackages

• pychord.constants package
  • Submodules
  • pychord.constants.qualities module
  • pychord.constants.scales module
  • Module contents

Submodules

pychord.analyzer module

pychord.analyzer.get_all_rotated_notes(notes)

Get all rotated notes

get_all_rotated_notes([1,3,5]) -> [[1,3,5],[3,5,1],[5,1,3]]

Return type:list[list[str]]

pychord.analyzer.note_to_chord(notes)

Convert note list to chord list

Parameters:notes (list[str]) – list of note arranged from lower note. ex) [“C”, “Eb”, “G”] Return type:list[pychord.Chord] Returns:list of chord

pychord.analyzer.notes_to_positions(notes, root)

Get notes positions.

ex) notes_to_positions([“C”, “E”, “G”], “C”) -> [0, 4, 7]

Parameters:

• notes (list[str]) – list of notes
• root (str) – the root note

Return type:

list[int]

Returns:

list of note positions

pychord.chord module

class pychord.chord.Chord(chord)

Bases: object

Class to handle a chord.

Parameters:

• _chord (str) – Name of the chord. (e.g. C, Am7, F#m7-5/A)
• _root (str) – The root note of chord.
• _quality (pychord.Quality) – The quality of chord. (e.g. m7, 6, M9, …)
• _appended (list[str]) – The appended notes on chord.
• _on (str) – The base note of slash chord.

appended

The appended notes on chord

chord

The name of chord

components(visible=True)

Return the component notes of chord

Parameters:visible (bool) – returns the name of notes if True else list of int Return type:list[(str or int)] Returns:component notes of chord

components_with_pitch(root_pitch)

Return the component notes of chord formatted like [“C4”, “E4”, “G4”]

Parameters:root_pitch (int) – the pitch of the root note Return type:list[str] Returns:component notes of chord

classmethod from_note_index(note, quality, scale, diatonic=False)

Create a Chord from note index in a scale

Chord.from_note_index(1, “”, “Cmaj”) returns I of C major => Chord(“C”) Chord.from_note_index(3, “m7”, “Fmaj”) returns IIImin of F major => Chord(“Am7”) Chord.from_note_index(5, “7”, “Amin”) returns Vmin of A minor => Chord(“E7”)

Parameters:

• note (int) – Note index in a Scale I, II, …, VIII
• quality (str) – Quality of a chord (m7, sus4, …)
• scale (str) – Base scale (Cmaj, Amin, F#maj, Ebmin, …)

Return type:

Chord

info()

Return information of chord to display

on

The base note of slash chord

quality

The quality of chord

root

The root note of chord

transpose(trans, scale='C')

Transpose the chord

Parameters:

• trans (int) – Transpose key
• scale (str) – key scale

Returns:

pychord.chord.as_chord(chord)

convert from str to Chord instance if input is str

Parameters:chord (str|pychord.Chord) – Chord name or Chord instance Return type:pychord.Chord Returns:Chord instance

pychord.parser module

pychord.parser.check_note(note, chord)

Return True if the note is valid.

Parameters:

• note (str) – note to check its validity
• chord (str) – the chord which includes the note

Return type:

bool

pychord.parser.parse(chord)

Parse a string to get chord component

Parameters:chord (str) – str expression of a chord Return type:(str, pychord.Quality, str, str) Returns:(root, quality, appended, on)

pychord.progression module

class pychord.progression.ChordProgression(initial_chords=None)

Bases: object

Class to handle chord progressions.

Parameters:_chords (list[pychord.Chord]) – component chords of chord progression.

append(chord)

Append a chord to chord progressions

Parameters:chord (str|pychord.Chord) – A chord to append Returns:

chords

Get component chords of chord progression

Return type:list[pychord.Chord]

insert(index, chord)

Insert a chord to chord progressions

Parameters:

• index (int) – Index to insert a chord
• chord (str|pychord.Chord) – A chord to insert

Returns:

pop(index=-1)

Pop a chord from chord progressions

Parameters:index (int) – Index of the chord to pop (default: -1) Returns:pychord.Chord

transpose(trans)

Transpose whole chord progressions

Parameters:trans (int) – Transpose key Returns:

pychord.quality module

class pychord.quality.Quality(name, components)

Bases: object

Chord quality

Parameters:_quality (str) – str expression of chord quality

append_note(note, root, scale=0)

Append a note to quality

Parameters:

• note (str) – note to append on quality
• root (str) – root note of chord
• scale (int) – key scale

append_notes(notes, root, scale=0)

Append notes to quality

Parameters:

• notes (list[str]) – notes to append on quality
• root (str) – root note of chord
• scale (int) – key scale

append_on_chord(on_chord, root)

Append on chord

To create Am7/G q = Quality(‘m7’) q.append_on_chord(‘G’, root=’A’)

Parameters:

• on_chord (str) – bass note of the chord
• root (str) – root note of the chord

get_components(root='C', visible=False)

Get components of chord quality

Parameters:

• root (str) – the root note of the chord
• visible (bool) – returns the name of notes if True

Return type:

list[str|int]

Returns:

components of chord quality

quality

Get name of quality

class pychord.quality.QualityManager

Bases: object

Singleton class to manage the qualities

find_quality_from_components(components)

Find a quality from components

Parameters:components (Tuple[int]) – components of quality

get_quality(name)

load_default_qualities()

set_quality(name, components)

Set a Quality

This method will not affect any existing Chord instances. :param str name: name of quality :param Tuple[int] components: components of quality

pychord.utils module

pychord.utils.display_appended(appended)

pychord.utils.display_on(on_note)

pychord.utils.note_to_val(note)

Convert note to int

>>> note_to_val("C")
0
>>> note_to_val("B")
11

Return type:int

pychord.utils.transpose_note(note, transpose, scale='C')

Transpose a note

Parameters:

• note (str) – note to transpose
• scale (str) – key scale

Return type:

str

Returns:

transposed note

pychord.utils.val_to_note(val, scale='C')

Convert int to note

>>> val_to_note(0)
"C"
>>> val_to_note(11, "D")
"D#"

Parameters:scale (str) – key scale Return type:str

Module contents