"Advertencia de importación no utilizada" y pylint

Question

Así que estoy trabajando en un proyecto en Python y tratando de mantenerlo en estándares con la pildora y en general. Por lo tanto, tengo un archivo de origen, (sólo tendremos que llamarlo a.py)

#a.py 
import loggingsetup 

def foo(): 
    log.info("This is a log message") 

Pero, quiero controlar lo que el registro se parece, por lo que en loggingsetup tengo algo como:

#loggingsetup.py 
import logging 

logging.root.setLevel(logging.DEBUG) 

consoleOut = logging.StreamHandler() 
consoleOut.setLevel(logging.INFO) 
consoleOut.setFormatter(logging.Formatter("\t"+logging.BASIC_FORMAT)) 
logging.root.addHandler(consoleOut) 

#etc 

Ahora, esto parece funcionar bien. Supongo que como pregunta preliminar debería preguntar si esta es la forma correcta de hacerlo, o si hay una forma diferente de estructurar mi código que sería preferible.

Pero mi pregunta principal es que cuando ejecuto pylint en a.py recibo una advertencia como "importación no utilizada - import loggingsetup", ya que en realidad no estoy llamando a ningún método o función de loggingsetup.

Podría hacer algo así como redefinir el cuerpo de loggingsetup como una función y llamarlo, pero parece tonto y propenso a errores (tendría que preocuparme de llamarlo dos veces si importase loggingsetup desde otro lugar, y si entiendo cómo Python maneja las importaciones, eso no es un problema con mi configuración actual).

Pudiera simplemente decirle a la empresa que ignore la advertencia, pero pensé que podría preguntar aquí primero para asegurarme de que esto no sea algo que deba manejar de manera diferente.

Answer 1

El enfoque que utilizaría es usar loggingsetup como una especie de envoltorio para logging.

import logging 

# set up logging config here 

from logging import * 

Luego, en los otros módulos que:

import loggingsetup as logging 

Es posible que desee utilizar un nombre que no sea loggingsetup en este caso, por ejemplo, tweaked_logging o logging_with_my_settings.

Answer 2

el código debe estar en una función llamada una vez en el script principal

Answer 3

Como se ha mencionado usted mismo envolviéndolo en una función y llamar a la configuración de forma explícita que solucionar esta advertencia. Y como mencionó Steven, esto se consideraría un mejor código ya que es más explícito sobre lo que estás haciendo.

Si le preocupa llamar a esta función dos veces, puede utilizar una bandera de módulo interno para permitir la ejecución del cuerpo de la función solo una vez.

__initialized = False 

def init(): 
    if not __initialized: 
     __initialized = True 
     #DoStuff 

Answer 4

En tales casos, todavía se puede decir de manera explícita pylint que esta importación no utilizado en la intención:

import loggingsetup # pylint: disable=unused-import 

Aviso la instrucción está en la misma línea que la importación de modo W0611 solamente está deshabilitada para esta línea , y no para todo el bloque de abajo.

Answer 5

Si utiliza pylint y flake8 puede pasar por alto la advertencia no utilizada de importaciones en ambas herramientas de esta manera:

import loggingsetup # noqa # pylint: disable=unused-import