Qt creator refactoring plugin how to#
Qt creator refactoring plugin full#
Qt creator refactoring plugin code#

DB management functionality would be available within the main QGIS window (from the Browser panel), instead of as a separate dialog.

“create schema”, “drop table”, “vacuum table” algorithms) In future, Processing algorithms may also be developed which would take advantage of these functions (e.g.

the ability to expose database management functionality via stable PyQGIS API, allowing other plugins and scripts to utilise this functionality.

testability and immediate feedback on API breaks (an advantage of C++ is that the application won’t even build if an API is changed or accidentally misused).

more usage of well-tested and well-maintained core C++ API.

no duplicate functionality, so it’s easier for users to understand and use.

We propose to start refactoring the DB-manager plugin functionality into core C++ implementation, reusing existing core API and replacing redundant duplicate functionality. Furthermore the nature of large Python codebases like db manager makes it very easy to accidentally break functionality with no warning or errors during development.

There are no unit tests for DB-Manager and this leads to frequent regressions, which (aside from being frustrating for users) consume a substantial part of our development time and budget during the bugfixing programs.

Users are forced to choose between two competing semi-complete alternatives, instead of having one, complete, well integrated solution.

After QGIS 3 API improvements concerning layer import and export functionality, there are many duplicated implementations between browser and db manager – some functionality is better in browser, some functionality is better in db manager.

After the QGIS 3.0 release, improvements within the core browser widgets implemented in C++ have resulted in a (constantly growing) degree of overlapping functionality between the browser and db manager.

DB-Manager is an important part of the QGIS interface, which allows browsing/previews of different DB-based data sources, complex queries, management of layers, import-export etc., DB creation and deletion etc.

Qt creator refactoring plugin full#

refactor and eliminate the remaining QGIS browser data items to make use of the abstract APIįor further information, the following paragraphs (taken from the original grant proposal) will provide full details about the background of this work.

Qt creator refactoring plugin code#

eliminate duplicate and untested code inside the Processing framework for working with Postgres databases and port the code to the new, stable, well-tested API.refactor and eliminate the remaining DB-manager connectors to make use of the abstract API.port all remaining data providers to the new API.In particular, future work should be undertaken to:

There is still a large amount of work to be done in order to complete all the desired refactoring and to remove all the Python and C++ code that will be ultimately be made redundant.

Qt creator refactoring plugin how to#

The new API was also used to implement the automatic loading of layer dependencies (not part of the grant program).įor developers interested in working with the new API, a set Python tests are available to show how to use the methods: (see also the postgres and spatialite companion tests). While the whole of the desired refactoring work was too big for a single grant request, the first work package has been completed and the following data providers have been partially or totally refactored to make use of the new connections API: The new API is documented in and it provides a few specializations for DB connections ( ) and an initial PR implementation for web service-based connections ( ). browse tables, drop/create a table/schema, run arbitrary SQL commands etc.) provide an abstract set of methods to perform most common operation on DB data sources (e.g.provide a unified way to store and retrieve data provider connections in the QGIS settings.