Skip to content

Python3 - Global variable 'widget' undefined at the module level

Python3
  • Jeder Python3 Einsteiger dürfte diese Meldung kennen. Auch in meinem Projekt nutze ich einige wenige Variablen an verschiedenen Stellen im Code. Das wirft dann in Pylint diese Fehlermeldung. Im verlinkten Beitrag findet man eine Erklärung warum das so ist.

    global tells python to look for a variable with this name in the global namespace and include it in the local namespace. This means it must exist in the global namespace first.

    import sys
    from PyQt5.QtWidgets import QApplication, QWidget
    
    m = None  # variable must exist in global namespace first
    
    def show():
        global m  # this creates a local m that is linked to the global m
        m = QWidget()
        m.setWindowTitle("Testing this app")
        m.show()
    
    MYAPP = QApplication(sys.argv)
    show()
    MYAPP.exec_()
    

    Das Beispiel aus dem Beitrag, zeigt das man die Variable im globalen Raum vorher deklarieren muss. Das mache ich jetzt so

    ###############################################
    ## Set global variables to avoid this message
    ## Global variable 'widget' undefined at the module level
    ###############################################
     
    widget = None
    mount_path = None
    restore_path = None
    row = None
    load_data = None
    

    Es wird überall immer erwähnt, das man globale Variablen unbedingt vermeiden soll. Das soll kein guter Programmierstil sein!? Dann habe ich jetzt eine gute Liste, um welche Variablen ich mich kümmern muss und werde diesen Teil so umschreiben, das ich das vermeiden kann.

    Quelle: https://stackoverflow.com/questions/55765372/python-error-global-declared-variable-is-not-declared-in-the-global-scope

  • Ok, da ich gestern schon wieder gelesen habe, das globale Variablen unbedingt zu vermeiden sind, habe ich mich mal dran gesetzt und nochmal drüber nachgedacht. Ausgangslage

    b9604f15-6e82-4865-bc44-f9ab2db2614e-grafik.png

    Die Einträge in der Backup List kann man per Mausklick auswählen und die Nummer des gewählten Eintrages brauch ich überall im Projekt.

    • kann man mit global row machen
    • kann man mit settings.setValue(entry_name, entry_value) machen
    • kann man mit einer Klasse lösen

    Mein erster Ansatz war, das mit global row zu machen. Das funktioniert auch einwandfrei. Mein zweiter Ansatz war, den Eintrag in einer Datei settings zu speichern. Auch das funktionierte einwandfrei. Aber beim Nachdenken, fiel mir dann wieder ein, ich muss mehr mit Klassen machen 😉

    Und genau beim Schreiben dieser Klasse ist mir dann aufgefallen, das das überhaupt nicht nötig ist 🤓

    Man kann sich doch die Zeile direkt holen.

    row = self.listWidget.currentRow()
    

    Die Zeile in allen Funktionen hinzugefügt und die globale Variable row war Geschichte. Jepp, man lernt Stück für Stück dazu...

  • Kein globalen Variablen mehr im Projekt 🙂

    Das Widget ließ sich relativ einfach erledigen.

    Vorher

    #----QPlainTextEdit ----#
    layout = QVBoxLayout()
    widget = QTextEdit()
    widget.setReadOnly(True)
    widget.setLayout(layout)
    setCentralWidget(widget)
    

    Nachher

    #----QPlainTextEdit ----#
    layout = QVBoxLayout()
    self.widget = QTextEdit()
    self.widget.setReadOnly(True)
    self.widget.setLayout(layout)
    self.setCentralWidget(self.widget)
    

    Aufruf dann nicht mehr mit

    # UI
    widget.setHtml("")
    

    sondern mit

    # UI
    mainWin.widget.setHtml("")
    

    Problem erledeigt und hoffentlich auch verstanden 😉

  • Python3 - pyqtSignal

    Python3
    1
    0 Stimmen
    1 Beiträge
    89 Aufrufe
    Niemand hat geantwortet
  • PyQt6 - QRegularExpressionValidator

    Python3
    1
    0 Stimmen
    1 Beiträge
    550 Aufrufe
    Niemand hat geantwortet
  • Restic UI - QThread

    Restic UI
    1
    0 Stimmen
    1 Beiträge
    117 Aufrufe
    Niemand hat geantwortet
  • Python3 - Umzug nach Fedora 34

    Python3
    1
    0 Stimmen
    1 Beiträge
    167 Aufrufe
    Niemand hat geantwortet
  • Python3 - subprocess.run

    Python3
    2
    0 Stimmen
    2 Beiträge
    212 Aufrufe
    FrankMF

    Ich möchte das Thema noch mal ausgraben. Bin beim Recherchieren über diese Links gestolpert, die mein Interesse geweckt haben.

    Link Preview Image Python Pipes to Avoid Shells — OpenStack Security Advisories 0.0.1.dev288 documentation

    favicon

    (security.openstack.org)

    B603: subprocess_without_shell_equals_true — Bandit documentation

    favicon

    (bandit.readthedocs.io)

    Da ich aktuell nur eine Desktop Anwendung entwickle, ist das Thema Sicherheit nicht ganz so wichtig, weil wer hackt sich schon selber!? Aber, da man ja nie weiß, wie so ein Tool evt. mal benutzt wird, sollte man von Anfang an auf ein paar Dinge achten.

    Ok, schauen wir uns das mal genauer an.

    Link 1 - shell=True

    Ich kopiere mal das Beispiel aus dem Link.

    def count_lines(website): return subprocess.check_output('curl %s | wc -l' % website, shell=True)

    Ok, das Problem ist

    shell=True

    Ein Beispiel aus meinem Projekt

    result = subprocess.run(['restic', '-r', backup_data[row].repository, 'stats'], input=pass_word.pw[0], capture_output=True, text=True)

    Gesetzt wird der in meinem Beispiel nicht. Besuchen wir mal die Webseite vom subprocess.run

    https://docs.python.org/3/library/subprocess.html?highlight=subprocess run#subprocess.run

    Wenn ich das jetzt richtig verstehe,

    subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None, **other_popen_kwargs)

    dann ist standardmäßig

    shell=False

    gesetzt. Damit ist das in meinem Projekt kein Problem.

    Link 2 - B603: subprocess_without_shell_equals_true

    Ein Tool auf gitlab.com wirft Security Warnings aus, dabei war diese. Schauen wir mal, was uns das sagen möchte.

    Python possesses many mechanisms to invoke an external executable. However, doing so may present a security issue if appropriate care is not taken to sanitize any user provided or variable input.

    Ok, es geht also um die Prüfung von Eingaben bzw. Variablen. Der Merksatz "Keine Benutzereingabe wird ungeprüft übernommen!" ist doch mit das Wichtigste, wenn man irgendwas programmiert. Nochmal mein Beispiel von oben.

    result = subprocess.run(['restic', '-r', backup_data[row].repository, 'stats'], input=pass_word.pw[0], capture_output=True, text=True)

    Ich übergebe dem Prozess einige Eingaben / Variablen.

    backup_data[row].repository pass_word.pw[0]

    Lesen wir wieder ein wenig in der Dokumentation von subprocess.run

    args is required for all calls and should be a string, or a sequence of program arguments. Providing a sequence of arguments is generally preferred, as it allows the module to take care of any required escaping and quoting of arguments (e.g. to permit spaces in file names). If passing a single string, either shell must be True (see below) or else the string must simply name the program to be executed without specifying any arguments.

    Das Wichtigste in Kürze Providing a sequence of arguments is generally preferred

    Der Aufruf von subprocess.run erwartet als erste Übergabe args

    subprocess.run(args, *, ....

    Mein Beispiel

    result = subprocess.run(['restic', '-r', backup_data[row].repository, 'stats'], ....

    Das zwischen den eckigen Klammern ist args. Laut der Anleitung ist es empfohlen, das als ein Argument zu übergeben, also so. Somit ist dafür gesorgt, das das Modul die Argumente selbst ein wenig "überwacht".

    as it allows the module to take care of any required escaping and quoting of arguments (e.g. to permit spaces in file names).

    Somit hätten man schon mal was für sie "Sicherheit" getan.

    args = ['restic', '-r', backup_data[row].repository, 'stats'] result = subprocess.run(args, ....

    Man sollte trotzdem auf diese beiden Variablen

    * backup_data[row].repository * pass_word.pw[0]

    ein Auge behalten. Ich denke, das habe ich in meinem Projekt eingehalten, indem ich Pfadangabe mit den Systemwerkzeugen auswählbar mache, keine Texteingaben! Passwörter und andere Bezeichnung werden mit regex auf korrekte Eingaben geprüft usw.

    Fazit

    Wieder viel gelernt und ich denke, es passt so weit alles. Bei der ganzen Spielerei, dann noch entdeckt, das ich im Code dieses Argument drin hatte.

    check=False

    Das ist aber Standard, somit kann das weg. Habe das im kompletten Projekt dann entfernt und mir fällt gerade auf, da der Code immer gleich ist, muss das jetzt eigentlich alles in eine Funktion 😉 Mal auf die ToDo-Liste drauf schreiben.

  • Python3 - subprocess.Popen

    Python3
    1
    0 Stimmen
    1 Beiträge
    281 Aufrufe
    Niemand hat geantwortet
  • Python3 - JSON

    Python3
    3
    0 Stimmen
    3 Beiträge
    200 Aufrufe
    FrankMF

    ede1a88a-5183-4f85-a602-27650362d532-grafik.png

    Die Backups sollen Namen haben, also habe ich das erweitert. Jetzt sollen diese als Liste rechts angezeigt werden. Das mache ich wie folgt.

    for key in backups: print(backups[key]['name'], key) liste = backups[key]['name'] + " ID: " + key self.listWidget.addItem(liste)

    Mittels des Keys kann ich auf den Namen zugreifen und die Liste damit füllen. Aktuell habe ich noch den Key hinten angefügt, weil ich noch keine Idee habe, wie ich die Backups anders verarbeiten soll. Aber, Stück für Stück. Der Backup-Name wird nach Auswahl in der Statusbar angezeigt. So weit klappt das so wie ich mir das vorstelle. Für heute ist Feierabend 😇

  • Wichtige Links

    Angeheftet Python3
    1
    0 Stimmen
    1 Beiträge
    184 Aufrufe
    Niemand hat geantwortet