haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Python environment variable handling 

The variables in the common settings struct are only updated on
save, so Python must use the ones from Pgm to get its values.
This does lead to the observation that Python's changes to the
variables do affect KiCad (they can break resolvers). So apparently
it can mess with us but we can't mess with it easily.

Also, improve the environment variable tracing infrastructure to capture
more changes.
This commit is contained in:
Ian McInerney 2020-08-12 00:11:48 +01:00
parent 63b53c3968
commit 47f7c616f8
6 changed files with 41 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
common/pgm_base.cpp
View File

@ -60,9 +60,6 @@
#include <trace_helpers.h>
static const wxChar traceEnvVars[] = wxT( "KIENVVARS" );
/**
* LanguagesList
* Note: because this list is not created on the fly, wxTranslation
@ -279,6 +276,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -286,6 +284,7 @@ bool PGM_BASE::InitPgm()
envVarItem.SetDefinedExternally( false );
}
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
wxFileName baseSharePath;
@ -311,6 +310,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -320,6 +320,7 @@ bool PGM_BASE::InitPgm()
}
envVarItem.SetValue( tmpFileName.GetPath() );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
// KISYS3DMOD
@ -329,6 +330,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -337,6 +339,7 @@ bool PGM_BASE::InitPgm()
}
envVarItem.SetValue( tmpFileName.GetFullPath() );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
// KICAD_TEMPLATE_DIR
@ -346,6 +349,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -386,6 +390,7 @@ bool PGM_BASE::InitPgm()
}
envVarItem.SetValue( tmpFileName.GetPath() );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
// KICAD_USER_TEMPLATE_DIR
@ -395,6 +400,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -406,6 +412,7 @@ bool PGM_BASE::InitPgm()
}
envVarItem.SetValue( tmpFileName.GetPath() );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
// KICAD_SYMBOLS
@ -415,6 +422,7 @@ bool PGM_BASE::InitPgm()
{
tmpFileName.AssignDir( envValue );
envVarItem.SetDefinedExternally( true );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Found entry %s externally", envVarName );
}
else
{
@ -424,6 +432,7 @@ bool PGM_BASE::InitPgm()
}
envVarItem.SetValue( tmpFileName.GetPath() );
wxLogTrace( traceEnvVars, "PGM_BASE::InitPgm: Setting entry %s = %s", envVarName, envVarItem.GetValue() );
m_local_env_vars[ envVarName ] = envVarItem;
GetSettingsManager().Load( GetCommonSettings() );
@ -503,7 +512,7 @@ void PGM_BASE::loadCommonSettings()
for( const auto& it : GetCommonSettings()->m_Env.vars )
{
wxString key( it.first.c_str(), wxConvUTF8 );
wxLogTrace( traceEnvVars, "Enumerating over entry %s = %s.", key, it.second );
wxLogTrace( traceEnvVars, "PGM_BASE::loadCommonSettings: Found entry %s = %s", key, it.second );
// Do not store the env var PROJECT_VAR_NAME ("KIPRJMOD") definition if for some reason
// it is found in config. (It is reserved and defined as project path)
@ -513,6 +522,8 @@ void PGM_BASE::loadCommonSettings()
if( m_local_env_vars[ key ].GetDefinedExternally() )
continue;
wxLogTrace( traceEnvVars, "PGM_BASE::loadCommonSettings: Updating entry %s = %s", key, it.second );
m_local_env_vars[ key ] = ENV_VAR_ITEM( it.second, wxGetEnv( it.first, nullptr ) );
}
@ -536,7 +547,8 @@ void PGM_BASE::SaveCommonSettings()
if( m_local_env_var.second.GetDefinedExternally() )
continue;
wxLogTrace( traceEnvVars, "Saving environment variable config entry %s as %s",
wxLogTrace( traceEnvVars,
"PGM_BASE::SaveCommonSettings: Saving environment variable config entry %s as %s",
GetChars( m_local_env_var.first ),
GetChars( m_local_env_var.second.GetValue() ) );
@ -703,12 +715,14 @@ bool PGM_BASE::SetLocalEnvVariable( const wxString& aName, const wxString& aValu
// Check to see if the environment variable is already set.
if( wxGetEnv( aName, &env ) )
{
wxLogTrace( traceEnvVars, "Environment variable %s already set to %s.",
wxLogTrace( traceEnvVars,
"PGM_BASE::SetLocalEnvVariable: Environment variable %s already set to %s",
GetChars( aName ), GetChars( env ) );
return env == aValue;
}
wxLogTrace( traceEnvVars, "Setting local environment variable %s to %s.",
wxLogTrace( traceEnvVars,
"PGM_BASE::SetLocalEnvVariable: Setting local environment variable %s to %s",
GetChars( aName ), GetChars( aValue ) );
return wxSetEnv( aName, aValue );
@ -726,7 +740,8 @@ void PGM_BASE::SetLocalEnvVariables( const ENV_VAR_MAP& aEnvVarMap )
// is run.
for( auto& m_local_env_var : m_local_env_vars )
{
wxLogTrace( traceEnvVars, "Setting local environment variable %s to %s.",
wxLogTrace( traceEnvVars,
"PGM_BASE::SetLocalEnvVariables: Setting local environment variable %s to %s",
GetChars( m_local_env_var.first ),
GetChars( m_local_env_var.second.GetValue() ) );
wxSetEnv( m_local_env_var.first, m_local_env_var.second.GetValue() );

1
common/trace_helpers.cpp
View File

@ -48,6 +48,7 @@ const wxChar* const traceZoomScroll = wxT( "KICAD_ZOOM_SCROLL" );
const wxChar* const traceSymbolResolver = wxT( "KICAD_SYM_RESOLVE" );
const wxChar* const traceDisplayLocation = wxT( "KICAD_DISPLAY_LOCATION" );
const wxChar* const traceSchSheetPaths = wxT( "KICAD_SCH_SHEET_PATHS" );
const wxChar* const traceEnvVars = wxT( "KICAD_ENV_VARS" );
wxString dump( const wxArrayString& aArray )

8
include/trace_helpers.h
View File

@ -174,6 +174,14 @@ extern const wxChar* const traceSymbolResolver;
*/
extern const wxChar* const traceSchSheetPaths;
/**
* Flag to enable debug output of environment variable operations.
*
* Use "KICAD_ENV_VARS" to enable
*
*/
extern const wxChar* const traceEnvVars;
///@}
/**

6
pcbnew/pcb_edit_frame.cpp
View File

@ -1272,10 +1272,10 @@ void PCB_EDIT_FRAME::PythonPluginsShowFolder()
void PCB_EDIT_FRAME::PythonSyncEnvironmentVariables()
{
#if defined( KICAD_SCRIPTING )
COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
const ENV_VAR_MAP& vars = Pgm().GetLocalEnvVariables();
for( auto& var : settings->m_Env.vars )
pcbnewUpdatePythonEnvVar( var.first, var.second );
for( auto& var : vars )
pcbnewUpdatePythonEnvVar( var.first, var.second.GetValue() );
#endif
}

6
pcbnew/swig/python_scripting.cpp
View File

@ -37,6 +37,7 @@
#include <common.h>
#include <gal/color4d.h>
#include <macros.h>
#include <trace_helpers.h>
#include <pgm_base.h>
@ -339,7 +340,7 @@ wxString PyEscapeString( const wxString& aSource )
}
void pcbnewUpdatePythonEnvVar( const std::string& aVar, const wxString& aValue )
void pcbnewUpdatePythonEnvVar( const wxString& aVar, const wxString& aValue )
{
char cmd[1024];
@ -347,6 +348,9 @@ void pcbnewUpdatePythonEnvVar( const std::string& aVar, const wxString& aValue )
if( !Py_IsInitialized() )
return;
wxLogTrace( traceEnvVars, "pcbnewUpdatePythonEnvVar: Updating Python variable %s = %s",
aVar, aValue );
wxString escapedVar = PyEscapeString( aVar );
wxString escapedVal = PyEscapeString( aValue );

2
pcbnew/swig/python_scripting.h
View File

@ -84,7 +84,7 @@ void pcbnewGetWizardsBackTrace( wxString& aNames );
* @param aVar is the variable to set
* @param aValue is the value to give it
*/
void pcbnewUpdatePythonEnvVar( const std::string& aVar, const wxString& aValue );
void pcbnewUpdatePythonEnvVar( const wxString& aVar, const wxString& aValue );
#ifdef KICAD_SCRIPTING_WXPYTHON