今すぐお試しください!

製品の詳細CData Python Connector for USPS を確認して、無償評価版をダウンロード:

今すぐダウンロード

SQLAlchemy ORM を使って、Python でUSPS データに連携

CData Python Connector for USPS を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でUSPS にOR マッピング可能に。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for USPS は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで USPS にデータ連携するPython アプリケーションを構築し、USPS data をビジュアライズできます。 本記事では、SQLAlchemy でUSPS に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムUSPS data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。USPS に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接USPS 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

USPS Data への接続

USPS data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

To authenticate with USPS, set the following connection properties.

  • PostageProvider: The postage provider to use to process requests. Available options are ENDICIA and STAMPS. If unspecified, this property will default to ENDICIA.
  • UseSandbox: This controls whether live or test requests are sent to the production or sandbox servers. If set to true, the Password, AccountNumber, and StampsUserId properties are ignored.
  • StampsUserId: This value is used for logging into authentication to the Stamps servers. This value is not applicable for Endicia and is optional if UseSandbox is true.
  • Password: This value is used for logging into Endicia and Stamps servers. If the postage provider is Endicia, this will be the pass phrase associated with your postage account. It is optional if UseSandbox is true.
  • AccountNumber: The shipper's account number. It is optional if UseSandbox is true.
  • PrintLabelLocation: This property is required to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

The Cache Database

Many of the useful task available from USPS require a lot of data. To ensure this data is easy to input and recall later, utilize a cache database to make requests. Set the cache connection properties in order to use the cache:

  • CacheLocation: The path to the cache location, for which a connection will be configured with the default cache provider. For example, C:\users\username\documents\uspscache

As an alternative to CacheLocation, set the combination of CacheConnection and CacheProvider to configure a cache connection using a provider separate from the default.

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからUSPS に接続します。

必要なモジュールのインストールs

pip でSQLAlchemy ツールキットをインストールします:

pip install sqlalchemy

モジュールのインポートを忘れずに行います:

import sqlalchemy

Python でUSPS Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、USPS data に連携するEngne を作成します。

engine = create_engine("usps///?PostageProvider=ENDICIA& RequestId=12345& Password='abcdefghijklmnopqr'& AccountNumber='12A3B4C'")

USPS Data のマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Senders テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。

base = declarative_base()
class Senders(base):
	__tablename__ = "Senders"
	FirstName = Column(String,primary_key=True)
	Phone = Column(String)
	...

USPS Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("usps///?PostageProvider=ENDICIA& RequestId=12345& Password='abcdefghijklmnopqr'& AccountNumber='12A3B4C'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Senders).filter_by(SenderID="25"):
	print("FirstName: ", instance.FirstName)
	print("Phone: ", instance.Phone)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Senders_table = Senders.metadata.tables["Senders"]
for instance in session.execute(Senders_table.select().where(Senders_table.c.SenderID == "25")):
	print("FirstName: ", instance.FirstName)
	print("Phone: ", instance.Phone)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

USPS Data の挿入(INSERT)

USPS data への挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、USPS にすべての追加インスタンスを送ります。

new_rec = Senders(FirstName="placeholder", SenderID="25")
session.add(new_rec)
session.commit()

USPS Data を更新(UPDATE)

USPS data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、USPS にレコードを追加します。

updated_rec = session.query(Senders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.SenderID = "25"
session.commit()

USPS Data を削除(DELETE)

USPS data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Senders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

製品の無償トライアル情報

USPS Python Connector の30日の無償トライアル をぜひダウンロードして、USPS data への接続をPython アプリやスクリプトから簡単に作成しましょう。

 
 
ダウンロード