Commit b340ad5d authored by Cédric Traizet's avatar Cédric Traizet

Merge branch 'display_deprecation_status' into 'develop'

Display deprecation status in application wrappers

See merge request !492
parents cb2f6d1b 507dafe0
Pipeline #1389 canceled with stage
in 8 minutes and 19 seconds
......@@ -24,7 +24,7 @@ before_script:
# Provision efficiently the local LFS cache before checkout
- git lfs fetch origin $CI_COMMIT_SHA
# Checkout the expected branch
- git checkout $CI_COMMIT_REF_NAME
- git checkout -f -q $CI_COMMIT_SHA
after_script:
- python3 CI/cdash_handler.py $CI_COMMIT_SHA $CI_PROJECT_ID $CI_PROJECT_DIR $K8S_SECRET_CDASH
......
......@@ -356,10 +356,17 @@ def make_links(text, allapps):
rep = {appname: ":ref:`{}`".format(appname) for appname in allapps}
return multireplace(text, rep)
def render_deprecation_string(app):
if app.IsDeprecated():
return "This application is deprecated and will be removed in a future release."
else:
return ""
def render_application(appname, allapps):
"Render app to rst"
app = otbApplication.Registry.CreateApplication(appname)
# Create the application without logger to avoid the deprecation warning log
app = otbApplication.Registry.CreateApplicationWithoutLogger(appname)
# TODO: remove this when bug 440 is fixed
app.Init()
......@@ -368,6 +375,7 @@ def render_application(appname, allapps):
output = template_application.format(
label=appname,
deprecation_string=render_deprecation_string(app),
heading=rst_section(app.GetName(), '='),
description=app.GetDescription(),
longdescription=make_links(app.GetDocLongDescription(), allapps),
......@@ -381,8 +389,9 @@ def render_application(appname, allapps):
return output
def GetApplicationTags(appname):
app = otbApplication.Registry.CreateApplication(appname)
return app.GetDocTags()
# Create the application without logger to avoid the deprecation warning log
app = otbApplication.Registry.CreateApplicationWithoutLogger(appname)
return app.GetDocTags()
def GenerateRstForApplications(rst_dir):
"Generate .rst files for all applications"
......@@ -404,9 +413,12 @@ def GenerateRstForApplications(rst_dir):
for appName in appNames:
# Get application first tag
tags = GetApplicationTags(appName)
tags = list(GetApplicationTags(appName))
if "Deprecated" in tags:
tags.remove("Deprecated")
if not tags or len(tags) == 0:
raise RuntimeError("No tags for application: " + appName)
tag = tags[0]
tag_ = tag.replace(" ", "_")
......
.. _{label}:
{heading}
{deprecation_string}
{description}
Description
......
......@@ -59,7 +59,7 @@ private:
"Input minimum and maximum values is automatically computed for all image bands.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocSeeAlso("DynamicConvert");
AddDocTag(Tags::Deprecated);
AddDocTag(Tags::Manip);
......
......@@ -96,12 +96,14 @@ private:
" application is not compatible with in-memory connection since it does"
" its own internal streaming.");
SetDocAuthors("David Youssefi");
SetDocSeeAlso( "[1] Michel, J., Youssefi, D., & Grizonnet, M. (2015). Stable"
" mean-shift algorithm and its application to the segmentation of"
" arbitrarily large remote sensing images. IEEE Transactions on"
" Geoscience and Remote Sensing, 53(2), 952-964.\n"
"[2] LSMSegmentation\n"
"[3] LSMSVectorization");
SetDocSeeAlso(
"Alternative: SmallRegionsMerging\n"
"[1] Michel, J., Youssefi, D., & Grizonnet, M. (2015). Stable"
" mean-shift algorithm and its application to the segmentation of"
" arbitrarily large remote sensing images. IEEE Transactions on"
" Geoscience and Remote Sensing, 53(2), 952-964.\n"
"[2] LSMSSegmentation\n"
"[3] LSMSVectorization");
AddDocTag(Tags::Segmentation);
AddDocTag(Tags::Deprecated);
AddDocTag("LSMS");
......
......@@ -669,6 +669,9 @@ public:
void AddDocTag(const std::string&);
/** return wether the application has the "deprecated tag or not */
bool IsDeprecated();
DocExampleStructure::Pointer GetDocExample();
unsigned int GetNumberOfExamples();
std::string GetExampleComment(unsigned int id);
......
......@@ -256,6 +256,11 @@ void Application::AddDocTag(const std::string & tag)
}
}
bool Application::IsDeprecated()
{
return std::find(m_DocTags.begin(), m_DocTags.end(), Tags::Deprecated) != m_DocTags.end();
}
DocExampleStructure::Pointer Application::GetDocExample()
{
if (!IsInitialized())
......
......@@ -112,9 +112,6 @@ public:
/** Create and display the help of the application */
void DisplayHelp(bool longHelp=false);
/** Create and display the long help of the application */
void DisplayLongHelp();
/** Performs specific action for testing environment */
void LoadTestEnv();
......
......@@ -282,7 +282,12 @@ bool CommandLineLauncher::BeforeExecute()
return false;
}
return true;
if (m_Application->IsDeprecated())
{
m_Application->GetLogger()->Warning("This application is deprecated and will be removed in a future OTB release.\n");
}
return true;
}
bool CommandLineLauncher::LoadPath()
......@@ -584,6 +589,12 @@ void CommandLineLauncher::DisplayHelp(bool longHelp)
std::cerr<<std::endl;
std::cerr << "This is the " << m_Application->GetName() << " application, version " << OTB_VERSION_STRING << std::endl << std::endl;
if (m_Application->IsDeprecated())
{
std::cerr << "WARNING: This application is deprecated, it will be removed in a future OTB release." << std::endl;
std::cerr << std::endl;
}
std::cerr << m_Application->GetDescription() << std::endl;
if(longHelp)
......
......@@ -117,6 +117,13 @@
</widget>
</widget>
</item>
<item alignment="Qt::AlignHCenter|Qt::AlignVCenter">
<widget class="QLabel" name="deprecation">
<property name="text">
<string>Deprecation status</string>
</property>
</widget>
</item>
<item>
<widget class="QLabel" name="message">
<property name="text">
......
......@@ -70,6 +70,18 @@ QtMainWindow::QtMainWindow(Application::Pointer app, QtWidgetView* gui, QWidget*
// Setup the progress bar to observe the model
ui->progressBar->SetModel(gui->GetModel());
// Fill and display the deprecation status label if needed, or hide it.
if (app->IsDeprecated())
{
ui->deprecation->setVisible(true);
ui->deprecation->setText("<font color='#E65100'>This application is deprecated and will be removed in a future release.</font>");
}
else
{
ui->deprecation->setVisible(false);
ui->deprecation->setText("");
}
// Connect application progress text to the QLabel
connect(ui->progressBar, &QtWidgetSimpleProgressReport::SetText, ui->message, &QLabel::setText);
......
......@@ -225,6 +225,7 @@ public:
unsigned long itk::Object::AddObserver(const EventObject & event,
Command * command);
bool IsDeprecated();
#if SWIGPYTHON
%extend
......@@ -901,6 +902,8 @@ public:
application = _otbApplication.Registry_CreateApplicationWithoutLogger(name)
if application is not None:
application.SetupLogger()
if application.IsDeprecated():
application.GetLogger().Warning("This application is deprecated and will be removed in a future OTB release")
return application
}
#else
......
......@@ -72,6 +72,15 @@ public:
virtual void AddLogOutput(itkLogOutput *output);
static Logger * Instance();
void ResetOutputs();
// Wrap message methods so we can print stuff from Python
void Debug(std::string const & message);
void Info(std::string const & message);
void Warning(std::string const & message);
void Critical(std::string const & message);
void Error(std::string const & message);
void Fatal(std::string const & message);
protected:
Logger();
virtual ~Logger();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment